item Class Reference

#include <item.h>

Inheritance diagram for item:

Collaboration diagram for item:

Public Member Functions
	item ()
virtual	~item ()
virtual void	print () const
	Standard print function.
virtual void	postprocess (input &indat)
virtual std::vector< std::string >	dependencies () const
	Returns dependencies of item, for which there are none.
virtual void	update ()
virtual std::string	type () const =0
void	setname (const std::string n)
void	set_write_name (std::string wname)
const std::string &	name () const
const std::string &	write_name () const

Static Public Member Functions
static std::shared_ptr< item >	create (std::string name, engineimp *rval)

Public Attributes
engineimp *	holder

Protected Member Functions
virtual void	_retrieve (retrieve_wrapper &&inval, item *caller)

Protected Attributes
std::string	_name
std::string	_write_name
char	has_write_name

Friends
class	input
class	native_item
template<class T >
void	retrieve (T &inval, item *setter, item *caller)

Detailed Description

Definition at line 31 of file item.h.

Constructor & Destructor Documentation

item::item

(

)

Definition at line 61 of file item.cpp.

item::~item ( )

virtual

Definition at line 60 of file item.cpp.

Member Function Documentation

void item::_retrieve ( retrieve_wrapper &&  p, item *  caller  )

protectedvirtual

This sets the value of object passed equal to the address of the current item

This is used for classes such as integrator, controller, etc which will comprise most of the item types here. This function can be rewritten for native types such as ints, etc

Reimplemented in native_item, variable, native_tmpl< T, act_name >, and list.

Definition at line 96 of file item.cpp.

Here is the caller graph for this function:

std::shared_ptr< item > item::create ( std::string  name, engineimp *  in  )

static

This function create an item of the type name

Parameters

name	Name of the item to be created

Returns

Pointer to the created item

Definition at line 147 of file item.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::vector< std::string > item::dependencies ( ) const

virtual

Returns dependencies of item, for which there are none.

Reimplemented in ftest3, ftest2, ftest1, example_rhs, stable_ode, native_item, jones_optical, c_elegans, example_integrator, simulation, stable_spectral_pde_1d_tmpl< T >, stable_spectral_pde_1d_tmpl< comp >, item_dim, integrator, rhs_CNLS, n_pulse_score, stable, controller, toroidal, rhs_SQGLE, ode, rk45, euler_sde, rk4, and objective.

Definition at line 116 of file item.cpp.

Here is the caller graph for this function:

const std::string & item::name

(

)

const

Returns the name of the variable

Returns

name of the variable

Definition at line 135 of file item.cpp.

Here is the caller graph for this function:

void item::postprocess ( input &  indat )

virtual

Reimplemented in example_rhs, stable_ode, native_item, example_integrator_tmpl< T >, jones_optical, example_integrator, c_elegans, stable_spectral_pde_1d_tmpl< T >, stable_spectral_pde_1d_tmpl< comp >, ode_tmpl< T >, simulation, rk45_tmpl< T >, item_dim, stable_ode_tmpl< T >, stable_ode_tmpl< comp >, rhs_CNLS, euler_sde_tmpl< T >, integrator, n_pulse_score, stable, controller, toroidal, rhs_SQGLE, ode, rk45, rk4_tmpl< T >, euler_sde, rk4, and objective.

Definition at line 65 of file item.cpp.

void item::print ( ) const

virtual

Standard print function.

Reimplemented in variable, and list.

Definition at line 120 of file item.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void item::set_write_name

(

std::string

wname

)

Definition at line 67 of file item.cpp.

void item::setname

(

const std::string

n

)

Sets the name of the variable

Parameters

n	Variable name

Definition at line 128 of file item.cpp.

virtual std::string item::type ( ) const

pure virtual

Implemented in ftest3, ftest2, ftest1, stable_ode, example_rhs, jones_optical, example_integrator_tmpl< T >, variable, jones_matrix, c_elegans, stable_spectral_pde_1d_tmpl< T >, stable_spectral_pde_1d_tmpl< comp >, rk45_tmpl< T >, ode_tmpl< T >, stable_ode_tmpl< T >, stable_ode_tmpl< comp >, integrator, euler_sde_tmpl< T >, example_integrator, rhs_CNLS, controller, toroidal, native_tmpl< T, act_name >, rhs_SQGLE, rk45, n_pulse_score, euler_sde, rk4, rk4_tmpl< T >, ode, and list.

Here is the caller graph for this function:

void item::update ( )

virtual

Updates structures that are held in the class. This is called after each iteration of the control algorithms so that items can update internal parameters such as matrices and whatnot. The controller updates the actual values for parameters so if a class only depends on the direct values than the function need not be re-implemented

Reimplemented in example_rhs, example_integrator_tmpl< T >, jones_matrix, c_elegans, and rhs_SQGLE.

Definition at line 107 of file item.cpp.

Here is the call graph for this function:

const std::string & item::write_name

(

)

const

Definition at line 71 of file item.cpp.

Friends And Related Function Documentation

friend class input

friend

Definition at line 60 of file item.h.

friend class native_item

friend

Definition at line 61 of file item.h.

template<class T >

void retrieve ( T &  inval, item *  setter, item *  caller  )

friend

Member Data Documentation

std::string item::_name

protected

Definition at line 39 of file item.h.

std::string item::_write_name

protected

Definition at line 40 of file item.h.

char item::has_write_name

protected

Definition at line 41 of file item.h.

engineimp* item::holder

Definition at line 45 of file item.h.

---

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

• engine/item.h
• engine/item.cpp