Navigation

Operators and Keywords

Function List:

C++ API

octave_user_function Class Reference

#include <ov-usr-fcn.h>

Inherits octave_user_code.

Collaboration diagram for octave_user_function:

List of all members.


Public Member Functions

 octave_user_function (symbol_table::scope_id sid=-1, tree_parameter_list *pl=0, tree_parameter_list *rl=0, tree_statement_list *cl=0)
 ~octave_user_function (void)
octave_functionfunction_value (bool=false)
const octave_functionfunction_value (bool=false) const
octave_user_functionuser_function_value (bool=false)
octave_user_codeuser_code_value (bool=false)
octave_user_functiondefine_param_list (tree_parameter_list *t)
octave_user_functiondefine_ret_list (tree_parameter_list *t)
void stash_fcn_file_name (const std::string &nm)
void stash_parent_fcn_name (const std::string &p)
void stash_parent_fcn_scope (symbol_table::scope_id ps)
void stash_leading_comment (octave_comment_list *lc)
void stash_trailing_comment (octave_comment_list *tc)
void mark_fcn_file_up_to_date (const octave_time &t)
void stash_fcn_file_time (const octave_time &t)
std::string fcn_file_name (void) const
std::string parent_fcn_name (void) const
symbol_table::scope_id parent_fcn_scope (void) const
symbol_table::scope_id scope (void)
octave_time time_parsed (void) const
octave_time time_checked (void) const
void mark_as_system_fcn_file (void)
bool is_system_fcn_file (void) const
bool is_user_function (void) const
void erase_subfunctions (void)
bool takes_varargs (void) const
bool takes_var_return (void) const
void lock_subfunctions (void)
void unlock_subfunctions (void)
octave_value_list all_va_args (const octave_value_list &args)
void stash_function_name (const std::string &s)
void mark_as_nested_function (void)
bool is_nested_function (void) const
void mark_as_inline_function (void)
bool is_inline_function (void) const
void mark_as_class_constructor (void)
bool is_class_constructor (void) const
void mark_as_class_method (void)
bool is_class_method (void) const
octave_value subsref (const std::string &type, const std::list< octave_value_list > &idx)
octave_value_list subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)
octave_value_list do_multi_index_op (int nargout, const octave_value_list &args)
tree_parameter_listparameter_list (void)
tree_parameter_listreturn_list (void)
tree_statement_listbody (void)
octave_comment_listleading_comment (void)
octave_comment_listtrailing_comment (void)
bool subsasgn_optimization_ok (void)
void accept (tree_walker &tw)

Constructor & Destructor Documentation

octave_user_function::octave_user_function ( symbol_table::scope_id  sid = -1,
tree_parameter_list pl = 0,
tree_parameter_list rl = 0,
tree_statement_list cl = 0 
)

octave_user_function::~octave_user_function ( void   ) 


Member Function Documentation

void octave_user_function::accept ( tree_walker tw  )  [virtual]

Reimplemented from octave_function.

octave_value_list octave_user_function::all_va_args ( const octave_value_list args  ) 

tree_statement_list* octave_user_function::body ( void   )  [inline, virtual]

Implements octave_user_code.

octave_user_function* octave_user_function::define_param_list ( tree_parameter_list t  ) 

octave_user_function * octave_user_function::define_ret_list ( tree_parameter_list t  ) 

octave_value_list octave_user_function::do_multi_index_op ( int  nargout,
const octave_value_list args 
) [virtual]

Reimplemented from octave_base_value.

void octave_user_function::erase_subfunctions ( void   )  [inline, virtual]

Reimplemented from octave_base_value.

std::string octave_user_function::fcn_file_name ( void   )  const [inline, virtual]

Reimplemented from octave_function.

const octave_function* octave_user_function::function_value ( bool  = false  )  const [inline, virtual]

Reimplemented from octave_base_value.

octave_function* octave_user_function::function_value ( bool  = false  )  [inline, virtual]

Reimplemented from octave_base_value.

bool octave_user_function::is_class_constructor ( void   )  const [inline, virtual]

Reimplemented from octave_function.

bool octave_user_function::is_class_method ( void   )  const [inline, virtual]

Reimplemented from octave_function.

bool octave_user_function::is_inline_function ( void   )  const [inline, virtual]

Reimplemented from octave_base_value.

bool octave_user_function::is_nested_function ( void   )  const [inline, virtual]

Reimplemented from octave_function.

bool octave_user_function::is_system_fcn_file ( void   )  const [inline, virtual]

Reimplemented from octave_function.

bool octave_user_function::is_user_function ( void   )  const [inline, virtual]

Reimplemented from octave_base_value.

octave_comment_list* octave_user_function::leading_comment ( void   )  [inline]

void octave_user_function::lock_subfunctions ( void   )  [virtual]

Reimplemented from octave_function.

void octave_user_function::mark_as_class_constructor ( void   )  [inline]

void octave_user_function::mark_as_class_method ( void   )  [inline]

void octave_user_function::mark_as_inline_function ( void   )  [inline]

void octave_user_function::mark_as_nested_function ( void   )  [inline]

void octave_user_function::mark_as_system_fcn_file ( void   ) 

void octave_user_function::mark_fcn_file_up_to_date ( const octave_time t  )  [inline, virtual]

Reimplemented from octave_function.

tree_parameter_list* octave_user_function::parameter_list ( void   )  [inline]

std::string octave_user_function::parent_fcn_name ( void   )  const [inline, virtual]

Reimplemented from octave_function.

symbol_table::scope_id octave_user_function::parent_fcn_scope ( void   )  const [inline, virtual]

Reimplemented from octave_function.

tree_parameter_list* octave_user_function::return_list ( void   )  [inline]

symbol_table::scope_id octave_user_function::scope ( void   )  [inline, virtual]

Reimplemented from octave_function.

void octave_user_function::stash_fcn_file_name ( const std::string nm  ) 

void octave_user_function::stash_fcn_file_time ( const octave_time t  )  [inline]

void octave_user_function::stash_function_name ( const std::string s  )  [inline]

void octave_user_function::stash_leading_comment ( octave_comment_list lc  )  [inline]

void octave_user_function::stash_parent_fcn_name ( const std::string p  )  [inline]

void octave_user_function::stash_parent_fcn_scope ( symbol_table::scope_id  ps  )  [inline]

void octave_user_function::stash_trailing_comment ( octave_comment_list tc  )  [inline]

bool octave_user_function::subsasgn_optimization_ok ( void   ) 

octave_value_list octave_user_function::subsref ( const std::string type,
const std::list< octave_value_list > &  idx,
int  nargout 
) [virtual]

Reimplemented from octave_base_value.

octave_value octave_user_function::subsref ( const std::string type,
const std::list< octave_value_list > &  idx 
) [inline, virtual]

Reimplemented from octave_base_value.

bool octave_user_function::takes_var_return ( void   )  const [virtual]

Reimplemented from octave_function.

bool octave_user_function::takes_varargs ( void   )  const [virtual]

Reimplemented from octave_function.

octave_time octave_user_function::time_checked ( void   )  const [inline, virtual]

Reimplemented from octave_function.

octave_time octave_user_function::time_parsed ( void   )  const [inline, virtual]

Reimplemented from octave_function.

octave_comment_list* octave_user_function::trailing_comment ( void   )  [inline]

void octave_user_function::unlock_subfunctions ( void   )  [virtual]

Reimplemented from octave_function.

octave_user_code* octave_user_function::user_code_value ( bool  = false  )  [inline, virtual]

Reimplemented from octave_base_value.

octave_user_function* octave_user_function::user_function_value ( bool  = false  )  [inline, virtual]

Reimplemented from octave_base_value.


The documentation for this class was generated from the following files: