Base class for templated classes derived from ParameteredObject. More...

#include <charon-core/ParameteredObject.h>

Inheritance diagram for TemplatedParameteredObject< T >:

Public Member Functions
	TemplatedParameteredObject (const std::string &className, const std::string &name="", const std::string &doc="")
	Default constructor. More...

virtual const std::string	getTemplateType () const
	get template type as string More...

Public Member Functions inherited from ParameteredObject
virtual	~ParameteredObject ()
	Delete parametered object. More...

void	clearMetadata ()
	delete metadata cache to save some space More...

bool	executed () const
	get execution status

std::string	fixCase (const std::string &parOrSlotName) const
	restore parameter/slot name casing

const ParameterFile &	getMetadata ()
	get metadata

virtual void	initialize ()
	initialize plugin More...

virtual void	loadParameters (const ParameterFile &pf)
	Load parameter from parameter file. More...

void	loadSlots (const ParameterFile &pf, const PluginManagerInterface *man)
	Load slot connection from parameter file. More...

virtual void	onLoad (const ParameterFile &pf, const PluginManagerInterface *man)
	Custom Load operation. More...

virtual void	onSave (ParameterFile &pf) const
	Custom Save operation. More...

virtual void	prepareDynamicInterface (const ParameterFile &file)
	prepare interface of parameters and slots More...

virtual void	resetExecuted (bool propagate=true)
	reset execution status More...

virtual void	run ()
	Update object. More...

void	save (ParameterFile &pf) const
	Save own content to the given parameter file. More...

virtual void	saveParameters (ParameterFile &pf) const
	Save parameters to parameter file. More...

virtual void	setExecuted (bool value)
	set property _executed More...

const std::string &	getClassName () const
	class name

const std::string &	getName () const
	instance name

Slot *	getSlot (const std::string &slotName) const
	Get pointer to some slot (by name) More...

const std::map< std::string, Slot * > &	getInputSlots () const
	Get all input slots as map. More...

const std::map< std::string, Slot * > &	getOutputSlots () const
	Get all output slots as map. More...

const std::map< std::string, AbstractParameter * > &	getParameters () const
	Get all Parameters as a map. More...

std::set< std::string >	getNeighbours () const
	Get connected neighbours of the current object. More...

std::set< std::string >	getNeighbours (const ParameterFile &pf) const
	Get connected neighbours of the current object. More...

virtual bool	connected () const
	Check if object is ready for work. More...

void	raise (const std::string &message) const
	throw an exception with information about the ParameteredObject More...

AbstractParameter &	getParameter (const std::string &name) const

template<typename T >
void	setParameter (std::string name, T value)

bool	isDynamic ()

Additional Inherited Members
Public Types inherited from ParameteredObject
enum	build_type { UNDEFINED_BUILD = 0, DEBUG_BUILD = 1, RELEASE_BUILD = 2 }
	defined build type More...

enum	template_type { TYPE_DOUBLE = 0, TYPE_FLOAT = 1, TYPE_INT = 2 }
	Integer which represents a template type. More...

Public Attributes inherited from ParameteredObject
Parameter< bool >	_active
	ParameteredObject activation state. More...

Protected Member Functions inherited from ParameteredObject
	ParameteredObject (const std::string &className, const std::string &name="", const std::string &doc="")
	Default constructor. More...

void	_addInputSlot (Slot &slot, const std::string &name, const std::string &displayname, const std::string &doc, const std::string &type)
	Register input slot. More...

void	_addOutputSlot (Slot &slot, const std::string &name, const std::string &displayname, const std::string &doc, const std::string &type)
	Register output slot. More...

void	_addParameter (AbstractParameter &param, const std::string &name, const std::string &doc, const std::string &type="")
	Add parameters. More...

template<class T >
void	_addParameter (Parameter< T > &param, const std::string &name, const std::string &doc, const T &defVal, const std::string &type="")
	Same function but adding a default value. More...

bool	_addSomething (const std::string &extension, const std::string &name, const std::string &doc, const std::string &type, const std::string &defaultValue="")
	Common code for _addParameter, _addInputSlot, _addOutputSlot. More...

void	_commitSlots ()
	commit slot data

std::set< ParameteredObject * >	_getTargetNodes ()
	get target nodes More...

void	_prepareSlots ()
	prepare slot data

void	_removeInputSlot (std::string name)
	Remove an input slot.

void	_removeOutputSlot (std::string name)
	Remove an output slot.

bool	_removeSomething (const std::string &extension, const std::string &name)
	Remove something. Iverse of _addSomething.

void	_setDynamic (bool v)
	Specifies if the ParameteredObject is dynamic.

void	_setTags (const std::string &tags)
	Register additional tag names for grouping ParameteredObjects. More...

virtual void	execute ()
	execute plugin code More...

virtual void	finalize ()
	finalize plugin More...

void	runPreceeding () const
	run all preceeding objects

void	runPreceeding (const Slot &slot) const
	run all preceeding objects connected to a particular slot More...

void	_addInputSlot (Slot &slot, const std::string &name, const std::string &doc, const std::string &type="")
	These functions needs to be called by the derived class in order to register all objects which can be used as inputs or outputs. More...

void	_addOutputSlot (Slot &slot, const std::string &name, const std::string &doc, const std::string &type="")
	Register output slot. More...

Detailed Description

template<typename T>
class TemplatedParameteredObject< T >

Implements the method getTemplateType, so it does not have to be implemented in every plugin.

Definition at line 580 of file ParameteredObject.h.

Constructor & Destructor Documentation

template<typename T >

TemplatedParameteredObject< T >::TemplatedParameteredObject	(	const std::string &	className,
		const std::string &	name = `""`,
		const std::string &	doc = `""`
	)

Init class name with given string. Also generates a unique instance name if necessary.

Parameters

className	Initialization value for className property.
name	Instance name (auto generation if empty)
doc	Class docstring (for metadata)

Definition at line 59 of file ParameteredObject.hxx.

References ParameteredObject::_addSomething().

Member Function Documentation

template<typename T >

const std::string TemplatedParameteredObject< T >::getTemplateType ( ) const

virtual

Returns the template type of a derived class of ParameteredObject. Most of the derived classes are templated.

Returns: Template type as std::string

Reimplemented from ParameteredObject.

Definition at line 75 of file ParameteredObject.hxx.

References TypeDetector::type().

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

include/charon-core/ParameteredObject.h
include/charon-core/ParameteredObject.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class TemplatedParameteredObject< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class TemplatedParameteredObject< T >