octave_function Class Reference

#include <ov-fcn.h>

Inherits octave_base_value.

Inherited by octave_builtin, octave_mex_function, and octave_user_code.

Collaboration diagram for octave_function:

List of all members.

Public Member Functions
	octave_function (void)
	~octave_function (void)
octave_base_value *	clone (void) const
octave_base_value *	empty_clone (void) const
bool	is_defined (void) const
bool	is_function (void) const
virtual bool	is_system_fcn_file (void) const
virtual std::string	fcn_file_name (void) const
virtual std::string	parent_fcn_name (void) const
virtual symbol_table::scope_id	parent_fcn_scope (void) const
virtual void	mark_fcn_file_up_to_date (const octave_time &)
virtual symbol_table::scope_id	scope (void)
virtual octave_time	time_parsed (void) const
virtual octave_time	time_checked (void) const
virtual bool	is_subfunction (void) const
virtual bool	is_class_constructor (const std::string &=std::string()) const
virtual bool	is_class_method (const std::string &=std::string()) const
virtual bool	takes_varargs (void) const
virtual bool	takes_var_return (void) const
void	stash_dispatch_class (const std::string &nm)
std::string	dispatch_class (void) const
virtual void	mark_as_private_function (const std::string &cname=std::string())
bool	is_private_function (void) const
bool	is_private_function_of_class (const std::string &nm)
std::string	dir_name (void) const
void	stash_dir_name (const std::string &dir)
void	lock (void)
void	unlock (void)
bool	islocked (void) const
virtual void	lock_subfunctions (void)
virtual void	unlock_subfunctions (void)
void	mark_relative (void)
bool	is_relative (void) const
std::string	name (void) const
void	document (const std::string &ds)
std::string	doc_string (void) const
virtual void	unload (void)
virtual void	accept (tree_walker &)
Protected Member Functions
	octave_function (const std::string &nm, const std::string &ds=std::string())
Protected Attributes
bool	relative
bool	locked
bool	private_function
std::string	xdispatch_class
std::string	my_name
std::string	my_dir_name
std::string	doc

---

Constructor & Destructor Documentation

octave_function::octave_function

(

void

)

[inline]

octave_function::~octave_function

(

void

)

[inline]

octave_function::octave_function	(	const std::string &	nm,
		const std::string &	ds = std::string ()
	)			[inline, protected]

---

Member Function Documentation

virtual void octave_function::accept

(

tree_walker &

)

[inline, virtual]

Reimplemented in octave_user_script, and octave_user_function.

octave_base_value * octave_function::clone

(

void

)

const [virtual]

Reimplemented from octave_base_value.

std::string octave_function::dir_name

(

void

)

const [inline]

std::string octave_function::dispatch_class

(

void

)

const [inline]

std::string octave_function::doc_string

(

void

)

const [inline]

void octave_function::document

(

const std::string &

ds

)

[inline]

octave_base_value * octave_function::empty_clone

(

void

)

const [virtual]

Reimplemented from octave_base_value.

virtual std::string octave_function::fcn_file_name

(

void

)

const [inline, virtual]

Reimplemented in octave_dld_function, octave_mex_function, octave_user_script, and octave_user_function.

virtual bool octave_function::is_class_constructor

(

const std::string &

= std::string ()

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual bool octave_function::is_class_method

(

const std::string &

= std::string ()

)

const [inline, virtual]

Reimplemented in octave_user_function.

bool octave_function::is_defined

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

bool octave_function::is_function

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

bool octave_function::is_private_function

(

void

)

const [inline]

bool octave_function::is_private_function_of_class

(

const std::string &

nm

)

[inline]

bool octave_function::is_relative

(

void

)

const [inline]

virtual bool octave_function::is_subfunction

(

void

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual bool octave_function::is_system_fcn_file

(

void

)

const [inline, virtual]

Reimplemented in octave_dld_function, octave_mex_function, and octave_user_function.

bool octave_function::islocked

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

void octave_function::lock

(

void

)

[inline, virtual]

Reimplemented from octave_base_value.

virtual void octave_function::lock_subfunctions

(

void

)

[inline, virtual]

Reimplemented in octave_user_function.

virtual void octave_function::mark_as_private_function

(

const std::string &

cname = std::string ()

)

[inline, virtual]

Reimplemented in octave_user_function.

virtual void octave_function::mark_fcn_file_up_to_date

(

const octave_time &

)

[inline, virtual]

Reimplemented in octave_dld_function, octave_mex_function, octave_user_script, and octave_user_function.

void octave_function::mark_relative

(

void

)

[inline]

std::string octave_function::name

(

void

)

const [inline]

virtual std::string octave_function::parent_fcn_name

(

void

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual symbol_table::scope_id octave_function::parent_fcn_scope

(

void

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual symbol_table::scope_id octave_function::scope

(

void

)

[inline, virtual]

Reimplemented in octave_user_function.

void octave_function::stash_dir_name

(

const std::string &

dir

)

[inline]

void octave_function::stash_dispatch_class

(

const std::string &

nm

)

[inline]

virtual bool octave_function::takes_var_return

(

void

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual bool octave_function::takes_varargs

(

void

)

const [inline, virtual]

Reimplemented in octave_user_function.

virtual octave_time octave_function::time_checked

(

void

)

const [inline, virtual]

Reimplemented in octave_dld_function, octave_mex_function, octave_user_script, and octave_user_function.

virtual octave_time octave_function::time_parsed

(

void

)

const [inline, virtual]

Reimplemented in octave_dld_function, octave_mex_function, octave_user_script, and octave_user_function.

virtual void octave_function::unload

(

void

)

[inline, virtual]

void octave_function::unlock

(

void

)

[inline, virtual]

Reimplemented from octave_base_value.

virtual void octave_function::unlock_subfunctions

(

void

)

[inline, virtual]

Reimplemented in octave_user_function.

---

Member Data Documentation

std::string octave_function::doc [protected]

bool octave_function::locked [protected]

std::string octave_function::my_dir_name [protected]

std::string octave_function::my_name [protected]

bool octave_function::private_function [protected]

bool octave_function::relative [protected]

std::string octave_function::xdispatch_class [protected]

---

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

• ov-fcn.h
• ov-fcn.cc