controller Class Reference

This is the base class for the control type classes. More...

#include <controller.h>

Inheritance diagram for controller:

Collaboration diagram for controller:

Public Member Functions
virtual std::vector< std::string >	dependencies () const
virtual void	postprocess (input &inval)
virtual void	addvar (std::weak_ptr< variable > v)=0
virtual std::string	type () const =0
virtual void	control (comp *u, objective *obj)=0
virtual char	is_good ()=0
virtual int	pre_set ()=0
Public Member Functions inherited from item_dim
size_t	get_dimension () const
Public Member Functions inherited from item
	item ()
virtual	~item ()
virtual void	print () const
	Standard print function.
virtual void	update ()
void	setname (const std::string n)
void	set_write_name (std::string wname)
const std::string &	name () const
const std::string &	write_name () const

Public Attributes
int	index
size_t	num_cont

Protected Attributes
std::vector< std::weak_ptr < variable > >	vars
int	act_index
Protected Attributes inherited from item_dim
mempool	memp
std::set< item_dim * >	children
item_dim *	parent
size_t	dimension
Protected Attributes inherited from item
std::string	_name
std::string	_write_name
char	has_write_name

Additional Inherited Members
Static Public Member Functions inherited from item
static std::shared_ptr< item >	create (std::string name, engineimp *rval)
Protected Member Functions inherited from item_dim
void	print_upstream ()
virtual void	_do_mem_update (size_t dim_old)
void	add_as_parent (item_dim *p)
void	add_as_parent (std::shared_ptr< item_dim > p)
void	update_dim (size_t dim_new)

Detailed Description

This is the base class for the control type classes.

This class provides the base for classes that execute control algorithms It stores the variables in memory and executes control on them

Definition at line 27 of file controller.h.

Member Function Documentation

virtual void controller::addvar ( std::weak_ptr< variable >  v )

pure virtual

Implemented in toroidal.

Here is the caller graph for this function:

virtual void controller::control ( comp *  u, objective *  obj  )

pure virtual

Implemented in toroidal.

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

virtual

This function returns the dependencies of the controller class

Note

This class depends on the variable names, as well as the dependencies for item_dim This class depends on:

 - string names: The names of the variables to be controlled

Variables can also be directly added by classes within the system. As of now, the names functionality is not yet implemented

See Also

item_dim::dependencies

Implements item_dim.

Reimplemented in toroidal.

Definition at line 32 of file controller.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual char controller::is_good ( )

pure virtual

Implemented in toroidal.

void controller::postprocess ( input &  inval )

virtual

Reimplemented from item_dim.

Reimplemented in toroidal.

Definition at line 37 of file controller.cpp.

Here is the call graph for this function:

virtual int controller::pre_set ( )

pure virtual

Implemented in toroidal.

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

pure virtual

Implements item.

Implemented in toroidal.

Member Data Documentation

int controller::act_index

protected

Definition at line 30 of file controller.h.

int controller::index

Definition at line 32 of file controller.h.

size_t controller::num_cont

Definition at line 33 of file controller.h.

std::vector<std::weak_ptr<variable> > controller::vars

protected

Definition at line 29 of file controller.h.

---

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

• controller/controller.h
• controller/controller.cpp