charon-core  0.3.1
WhileGroup Class Reference
Inheritance diagram for WhileGroup:

Public Member Functions

 WhileGroup (const std::string &name="")
 default constructor More...
 
void executeGroup ()
 Update object.
 
void initializeGroup ()
 Group Initialization. More...
 
virtual void initializeWhileGroup ()
 
- Public Member Functions inherited from ParameteredGroupObject
 ParameteredGroupObject (const std::string &className="ParameteredGroupObject", const std::string &name="", const std::string &doc="")
 Default constructor. More...
 
virtual ~ParameteredGroupObject ()
 Default deconstructor.
 
void breakLoop (int input)
 breakLoop More...
 
void disableLoopConnections ()
 disableLoopConnections
 
void enableLoopConnections ()
 enableLoopConnections More...
 
void execute ()
 Execution. More...
 
void finalize ()
 Finalization. More...
 
virtual void finalizeGroup ()
 Finalization. More...
 
void initialize ()
 Initialization. More...
 
void loopInputToOutput (int input, int output)
 LoopOutToInput. More...
 
virtual void onLoad (const ParameterFile &pf, const PluginManagerInterface *man)
 Custom load. More...
 
virtual void onSave (ParameterFile &pf) const
 Custom save. More...
 
virtual void prepareDynamicInterface (const ParameterFile &file)
 Prepare the interface. More...
 
virtual void setExecuted (bool value)
 set property _executed 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 ParameterFilegetMetadata ()
 get metadata
 
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 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...
 
const std::string & getClassName () const
 class name
 
const std::string & getName () const
 instance name
 
virtual const std::string getTemplateType () const
 get template type as string More...
 
SlotgetSlot (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...
 
AbstractParametergetParameter (const std::string &name) const
 
template<typename T >
void setParameter (std::string name, T value)
 
bool isDynamic ()
 

Public Attributes

InputSlot< bool > statement
 
- Public Attributes inherited from ParameteredGroupObject
Parameter< bool > debugSuffix
 
ParameterList< std::string > pluginPaths
 plugin search paths which are used when executing this loop
 
Parameter< std::string > workFlowFile
 
- Public Attributes inherited from ParameteredObject
Parameter< bool > _active
 ParameteredObject activation state. More...
 

Private Attributes

StatementIntf_innerWhilestatement
 

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...
 
- Protected Member Functions inherited from ParameteredGroupObject
virtual void onAddInputSlot (VirtualInputSlot *in)
 
virtual void onAddOutputSlot (VirtualOutputSlot *out)
 
- 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...
 
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...
 
- Protected Attributes inherited from ParameteredGroupObject
InputSlotBundleIntf_inputs
 
std::map< int,
VirtualOutputSlot * > 
_loopedSlots
 
std::vector< Parameter< int > * > _loopOutputNumber
 
OutputSlotBundleIntf_outputs
 
PluginManager_pluginMan
 

Detailed Description

Definition at line 47 of file WhileGroup.h.

Constructor & Destructor Documentation

WhileGroup::WhileGroup ( const std::string &  name = "")
Parameters
nameinstance name

Definition at line 29 of file WhileGroup.cpp.

References ParameteredObject::_addInputSlot(), and ParameteredObject::_setTags().

Member Function Documentation

void WhileGroup::initializeGroup ( )
virtual

Does nothing. Can be used in derived classes.

Reimplemented from ParameteredGroupObject.

Definition at line 86 of file WhileGroup.cpp.

References PluginManager::getObjectList().


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