Actin  Version 5.5.3
Software for Robotics Simulation and Control
EcXmlVariableElementType< ElementType > Class Template Reference

Holds an abstract base class for a variable element type. More...

#include <ecXmlVarElemType.h>

Inherits EcXmlBaseVariableCompoundType.

Inherited by Ec2DShapeContainer, EcActuationMechanismContainer, EcCluster, EcConvergenceToolContainer, EcDirectionConditionContainer, EcDirectorObjectContainer, EcExcavationInteractionContainer, EcForceControlFunctionContainer, EcFrameContainer, EcFrameTransitionEventContainer, EcGraspFrameContainer, EcGraspFrameStateContainer, EcGraspFrameTransitionEventContainer, EcGraspFrameTransitionEventStateContainer, EcGraspOffsetContainer, EcGraspOffsetStateContainer, EcIndividualJointControllerContainer, EcIntegratorContainer, EcJointActuatorContainer, EcJointSolutionConvergenceToolContainer, EcJointSolutionFinderContainer, EcManipulationFrameStateContainer, EcManipulationFrameTransitionEventStateContainer, EcManipulationOffsetStateContainer, EcManipulationSceneContainer, EcManipulationSceneDirectionContainer, EcManipulationSceneDirectionIssuesContainer, EcManipulationSceneDirectionSimpleStateContainer, EcManipulationSceneDirectionStateContainer, EcManipulationSceneStateContainer, EcMechanicalActuatorComponentContainer, EcMobileBaseControllerContainer, EcOffsetContainer, EcPlanarShapeContainer, EcPositionControlContainer, EcPowerConverterContainer, EcProximityToolContainer, EcRigidWheelSoilInteractionContainer, EcRrtPathPlannerContainer, EcRrtUtilityContainer, EcSimulationBuilderContainer, EcSolutionFinderContainer, EcSolutionValidatorContainer, EcStageIGraspingContainer, EcStageIIGraspingContainer, EcStageIIIGraspingContainer, EcSystemControlExectiveBuilderContainer, and EcWaypointInterpolatorContainer.

Collaboration diagram for EcXmlVariableElementType< ElementType >:

Public Member Functions

 ECXMLOBJECT (EcXmlVariableElementType)
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.
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
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
virtual EcXmlObjectclone () const =0
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.

Protected Member Functions

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

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

Additional Inherited Members

- 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

template<class ElementType>
class EcXmlVariableElementType< ElementType >

Holds an abstract base class for a variable element type.

Definition at line 14 of file ecXmlVarElemType.h.

Member Function Documentation

template<class ElementType>
EcXmlVariableElementType< ElementType >::ECXMLOBJECT ( EcXmlVariableElementType< ElementType >  )

ECXMLOBJECT(EcCls) Macro declares a constructor, destructor, copy constructor, classtoken method, equal operator, and equality operator and defines equality method, newObject method, and token method

template<class ElementType>
virtual EcBoolean EcXmlVariableElementType< ElementType >::readValueFromToken ( const EcToken token,
EcXmlReader stream 

read an XML object from a stream after reading the start tag return value signals success or failure

Implements EcXmlBaseVariableCompoundType.

Reimplemented in EcDirectorObjectContainer.

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