octave::fcn_info Class Reference

#include "fcn-info.h"

Collaboration diagram for octave::fcn_info:

Classes
class	fcn_info_rep

Public Types
typedef std::map< std::string, octave_value >::const_iterator	str_val_const_iterator
typedef std::map< std::string, octave_value >::iterator	str_val_iterator

Public Member Functions
	fcn_info (const std::string &nm="")
	fcn_info (const fcn_info &)=default
	~fcn_info (void)=default
octave_value	builtin_find (void)
void	clear (bool force=false)
void	clear_autoload_function (bool force=false)
void	clear_mex_function (void)
void	clear_user_function (bool force=false)
octave_value	dump (void) const
octave_value	find (const octave_value_list &args=octave_value_list(), bool local_funcs=true)
octave_value	find_autoload (void)
octave_value	find_built_in_function (void) const
octave_value	find_cmdline_function (void) const
octave_value	find_function (const octave_value_list &args=octave_value_list(), bool local_funcs=true)
octave_value	find_method (const std::string &dispatch_type) const
octave_value	find_user_function (void)
void	install_built_in_dispatch (const std::string &klass)
void	install_built_in_function (const octave_value &f)
void	install_cmdline_function (const octave_value &f)
void	install_local_function (const octave_value &f, const std::string &file_name)
void	install_user_function (const octave_value &f)
bool	is_user_function_defined (void) const
fcn_info &	operator= (const fcn_info &)=default

Private Attributes
std::shared_ptr< fcn_info_rep >	m_rep

Detailed Description

Definition at line 39 of file fcn-info.h.

Member Typedef Documentation

str_val_const_iterator

typedef std::map<std::string, octave_value>::const_iterator octave::fcn_info::str_val_const_iterator

Definition at line 44 of file fcn-info.h.

str_val_iterator

typedef std::map<std::string, octave_value>::iterator octave::fcn_info::str_val_iterator

Definition at line 45 of file fcn-info.h.

Constructor & Destructor Documentation

fcn_info() [1/2]

octave::fcn_info::fcn_info ( const std::string &  nm = "" )

inline

Definition at line 232 of file fcn-info.h.

fcn_info() [2/2]

octave::fcn_info::fcn_info ( const fcn_info &  )

default

~fcn_info()

octave::fcn_info::~fcn_info ( void  )

default

Member Function Documentation

builtin_find()

octave_value octave::fcn_info::builtin_find ( void  )

inline

Definition at line 247 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::builtin_find().

clear()

void octave::fcn_info::clear ( bool  force = false )

inline

Definition at line 315 of file fcn-info.h.

References m_rep.

clear_autoload_function()

void octave::fcn_info::clear_autoload_function ( bool  force = false )

inline

Definition at line 322 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::clear_dld_function().

clear_mex_function()

void octave::fcn_info::clear_mex_function ( void  )

inline

Definition at line 327 of file fcn-info.h.

References m_rep.

clear_user_function()

void octave::fcn_info::clear_user_function ( bool  force = false )

inline

Definition at line 317 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::clear_dld_function(), and octave::symbol_table::clear_user_function().

dump()

octave_value octave::fcn_info::dump ( void  ) const

inline

Definition at line 329 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::dump_fcn_table_map().

find()

octave_value octave::fcn_info::find ( const octave_value_list &  args = octave_value_list (), bool  local_funcs = true  )

inline

Definition at line 241 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::fcn_table_find().

find_autoload()

octave_value octave::fcn_info::find_autoload ( void  )

inline

Definition at line 267 of file fcn-info.h.

References m_rep.

Referenced by octave::fcn_info::fcn_info_rep::x_builtin_find(), and octave::fcn_info::fcn_info_rep::xfind().

find_built_in_function()

octave_value octave::fcn_info::find_built_in_function ( void  ) const

inline

Definition at line 257 of file fcn-info.h.

References m_rep.

find_cmdline_function()

octave_value octave::fcn_info::find_cmdline_function ( void  ) const

inline

Definition at line 262 of file fcn-info.h.

References m_rep.

find_function()

octave_value octave::fcn_info::find_function ( const octave_value_list &  args = octave_value_list (), bool  local_funcs = true  )

inline

Definition at line 282 of file fcn-info.h.

References m_rep.

find_method()

octave_value octave::fcn_info::find_method ( const std::string &  dispatch_type ) const

inline

Definition at line 252 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::find_method(), octave::fcn_info::fcn_info_rep::load_class_method(), and octave::fcn_info::fcn_info_rep::xfind().

find_user_function()

octave_value octave::fcn_info::find_user_function ( void  )

inline

Definition at line 272 of file fcn-info.h.

References m_rep.

Referenced by octave::fcn_info::fcn_info_rep::load_class_constructor(), octave::fcn_info::fcn_info_rep::x_builtin_find(), and octave::fcn_info::fcn_info_rep::xfind().

install_built_in_dispatch()

void octave::fcn_info::install_built_in_dispatch ( const std::string &  klass )

inline

Definition at line 310 of file fcn-info.h.

References m_rep.

Referenced by octave::symbol_table::install_built_in_dispatch().

install_built_in_function()

void octave::fcn_info::install_built_in_function ( const octave_value &  f )

inline

Definition at line 305 of file fcn-info.h.

References f, and m_rep.

Referenced by octave::symbol_table::alias_built_in_function(), and octave::symbol_table::install_built_in_function().

install_cmdline_function()

void octave::fcn_info::install_cmdline_function ( const octave_value &  f )

inline

Definition at line 289 of file fcn-info.h.

References f, and m_rep.

Referenced by octave::symbol_table::install_cmdline_function().

install_local_function()

void octave::fcn_info::install_local_function ( const octave_value &  f, const std::string &  file_name  )

inline

Definition at line 294 of file fcn-info.h.

References f, and m_rep.

Referenced by octave::symbol_table::install_local_function().

install_user_function()

void octave::fcn_info::install_user_function ( const octave_value &  f )

inline

Definition at line 300 of file fcn-info.h.

References f, and m_rep.

Referenced by octave::symbol_table::install_user_function().

is_user_function_defined()

bool octave::fcn_info::is_user_function_defined ( void  ) const

inline

Definition at line 277 of file fcn-info.h.

References m_rep.

operator=()

fcn_info& octave::fcn_info::operator= ( const fcn_info &  )

default

Member Data Documentation

m_rep

std::shared_ptr<fcn_info_rep> octave::fcn_info::m_rep

private

Definition at line 333 of file fcn-info.h.

Referenced by builtin_find(), clear(), clear_autoload_function(), clear_mex_function(), clear_user_function(), dump(), find(), find_autoload(), find_built_in_function(), find_cmdline_function(), find_function(), find_method(), find_user_function(), install_built_in_dispatch(), install_built_in_function(), install_cmdline_function(), install_local_function(), install_user_function(), and is_user_function_defined().

---

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

• libinterp/corefcn/fcn-info.h