Actin  Version 5.5.5
Software for Robotics Simulation and Control
EcSimulationBuilderContainer Class Reference

Holds a container for a simulation builder. More...

#include <ecSimulationBuilderContainer.h>

Inheritance diagram for EcSimulationBuilderContainer:
[legend]
Collaboration diagram for EcSimulationBuilderContainer:
[legend]

Public Member Functions

 ECXMLOBJECT (EcSimulationBuilderContainer)
 
virtual void registerComponentCreators () EC_OVERRIDE
 Elements in this variable map can be registered by overriding this virtual method. Default implementation is empty and supports only plugin types with library attribute. More...
 
virtual EcBoolean getSimulation (EcSystemSimulation &simulation, const EcU32 xmlReaderModifierFlag=0, EcInt32 *pProgress=EcNULL) const
 get simulation More...
 
- Public Member Functions inherited from EcXmlVariableElementType< ElementType >
 ECXMLOBJECT (EcXmlVariableElementType)
 
virtual const ElementType * element () const
 gets a pointer to the top expression (const)
 
virtual ElementType * element ()
 gets a pointer to the top expression (nonconst)
 
virtual void setElement (const ElementType &element)
 sets the top expression through a copy
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read this object from an XML stream
 
virtual EcBoolean write (EcXmlWriter &stream) const EC_OVERRIDE
 write this object to an XML stream
 
- Public Member Functions inherited from EcXmlBaseVariableCompoundType
 ECDECLARE_BIGFOUR (EcXmlBaseVariableCompoundType)
 
virtual EcBoolean xmlInit () EC_OVERRIDE
 xml-initialize
 
virtual void registerComponentCreator (const EcToken &token, EcXmlObjectCreator creator)
 register a single optional component
 
virtual EcXmlObjectnewObjectFromToken (const EcToken &token) const
 create a new object from its token
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const EC_OVERRIDE
 write this object to an XML stream
 
virtual const EcXmlStringVectoraddLibraries () const
 gets the library names (minus extension)
 
virtual void setAddLibraries (const EcXmlStringVector &addLibraries)
 sets the library names (minus extension)
 
virtual const EcXmlCreatorMapcreatorMap () const
 gets the creator map
 
- Public Member Functions inherited from EcXmlObject
 ECDECLARE_BIGFOUR (EcXmlObject)
 
virtual EcXmlObjectclone () const =0
 clone
 
virtual EcBoolean readAttribute (EcXmlReader &stream)
 read this attribute from an XML stream
 
virtual EcBoolean createSchema (const EcString &filename, const EcToken &objectName=EcXml::EcDefaultToken) const
 create schema
 
virtual EcBoolean xmlInitialized () const
 get XML initialized flag. This bit is set on initialization.
 
virtual void setXmlInitialized (EcBoolean val=EcTrue)
 set XML initialized flag. This bit is set on initialization.
 
virtual EcBoolean specified () const
 get specified flag. This bit is set upon reading from an XML file.
 
virtual void setSpecified (EcBoolean val=EcTrue)
 set specified flag. This bit is set upon reading from an XML file.
 
virtual EcBoolean isBasicType () const
 Return true/false for basic type.
 
virtual EcBoolean equalsDefault () const
 tests equality of XML object with default
 
virtual EcBoolean equality (const EcXmlObject *other) const =0
 equality - a virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const =0
 creates new object - a virtual new to an EcXmlObject pointer
 
virtual const EcTokentoken () const =0
 gets the xml token used for writing out.
 

Additional Inherited Members

- Protected Member Functions inherited from EcXmlVariableElementType< ElementType >
virtual EcBoolean readValueFromToken (const EcToken &token, EcXmlReader &stream) EC_OVERRIDE
 
- Protected Member Functions inherited from EcXmlBaseVariableCompoundType
virtual void processLibraries ()
 process the add libraries
 
- Protected Attributes inherited from EcXmlVariableElementType< ElementType >
ElementType * m_pElement
 the top expression element
 
- Protected Attributes inherited from EcXmlBaseVariableCompoundType
EcXmlFactory m_XmlFactory
 A map holding the relationship between string labels and subcomponents.
 
EcXmlStringVector m_AddLibraries
 the arry of library names
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 
- Static Protected Attributes inherited from EcXmlObject
static const EcU8 m_theXmlInitializedBit
 the bit used to describe xml initialization
 
static const EcU8 m_theSpecifiedBit
 the bit used to describe specification
 

Detailed Description

Holds a container for a simulation builder.

Definition at line 20 of file ecSimulationBuilderContainer.h.

Member Function Documentation

EcSimulationBuilderContainer::ECXMLOBJECT ( EcSimulationBuilderContainer  )

ECXMLOBJECT(EcCls) Macro declares a constructor, destructor, copy constructor, equal operator, and equality operator

virtual EcBoolean EcSimulationBuilderContainer::getSimulation ( EcSystemSimulation simulation,
const EcU32  xmlReaderModifierFlag = 0,
EcInt32 pProgress = EcNULL 
) const
virtual

get simulation

Returns
True if successful
Parameters
[out]simulationsimulation The simulation
[in]xmlReaderModifierFlagEcXmlReader::XMLREADER_NO_MODIFIERS
virtual void EcSimulationBuilderContainer::registerComponentCreators ( )
virtual

Elements in this variable map can be registered by overriding this virtual method. Default implementation is empty and supports only plugin types with library attribute.

Reimplemented from EcXmlVariableElementType< ElementType >.


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