 |
Actin
Version 5.5.2
Software for Robotics Simulation and Control
|
|
Actin
Version 5.5.2
Software for Robotics Simulation and Control
|
Holds EcManipulationDirector simple state information. More...
#include <ecManipulationDirectorSimpleState.h>
Public Member Functions | |
| EcManipulationDirectorSimpleState () | |
| default constructor | |
| virtual | ~EcManipulationDirectorSimpleState () |
| destructor | |
| EcManipulationDirectorSimpleState (const EcManipulationDirectorSimpleState &orig) | |
| copy constructor | |
| EcManipulationDirectorSimpleState & | operator= (const EcManipulationDirectorSimpleState &orig) |
| assignment operator | |
| EcBoolean | operator== (const EcManipulationDirectorSimpleState &orig) const |
| equality operator | |
| virtual EcXmlObject * | clone () const EC_OVERRIDE |
| clone - a virtual constructor to an EcXmlObject pointer | |
| virtual void | registerComponents () EC_OVERRIDE |
| register components with the parent | |
| virtual EcBoolean | equality (const EcXmlObject *other) const EC_OVERRIDE |
| equality - virtual equality to an EcXmlObject pointer | |
| virtual EcXmlObject * | newObject () const EC_OVERRIDE |
| virtual new that returns an EcXmlObject | |
| virtual const EcXmlStringStringMap & | manualPauseMessageMap () const |
| get the map of manual pause messages keyed by uuid | |
| EcReal | progress () const |
| get the progress of the director | |
| virtual const EcXmlStringStringMap & | roleObjectRoleMap () const |
| get the map of roles to object roles | |
| virtual const EcManipulationScriptSimpleState & | scriptState () const |
| get the script state | |
| virtual EcBoolean | singleStepFlag () const |
| get the flag indicating whether to run in single-step mode | |
| virtual const EcSimpleIssues & | directorIssues () const |
| get the director issues | |
| virtual const EcToken & | token () const EC_OVERRIDE |
| get the token | |
 Public Member Functions inherited from EcXmlCompoundType | |
| ECDECLARE_BIGFOUR (EcXmlCompoundType) | |
| virtual EcBoolean | xmlInit () EC_OVERRIDE |
| xmlInitialize | |
| virtual EcBoolean | read (EcXmlReader &stream) EC_OVERRIDE |
| read object from an XML stream | |
| virtual EcBoolean | readAttributes (EcXmlReader &stream) |
| read object attributes from an XML stream | |
| virtual EcBoolean | readElements (EcXmlReader &stream) |
| read object elements from an XML stream | |
| virtual EcBoolean | write (EcXmlWriter &stream) const EC_OVERRIDE |
| write object to an XML stream | |
| virtual EcBoolean | writeAttributes (EcXmlWriter &stream) const |
| write object attributes to an XML stream | |
| virtual EcBoolean | writeElements (EcXmlWriter &stream) const |
| write object elements to an XML stream | |
| virtual EcBoolean | writeSchema (EcXmlSchema &stream) const EC_OVERRIDE |
| write schema | |
| virtual EcBoolean | writeSchemaAttributes (EcXmlSchema &stream) const |
| write schema attributes | |
| virtual EcBoolean | writeSchemaElements (EcXmlSchema &stream) const |
| write schema elements | |
| virtual void | registerComponent (const EcToken &token, EcXmlObject *obj) |
| register a single component More... | |
| virtual void | registerComponent (EcXmlObject *obj) |
| register a single component More... | |
| virtual void | registerComponentReadOnly (const EcToken &token, EcXmlObject *obj) |
| register a single component as read-only More... | |
| virtual const EcXmlComponentMap & | componentMap () const |
| get a reference to the component map | |
| virtual void | registerAttributeComponent (const EcToken &AttribToken, EcXmlObject *Obj) |
| register a single attribute component More... | |
| virtual void | registerAttributeComponentReadOnly (const EcToken &AttribToken, EcXmlObject *Obj) |
| register a single attribute component read-only More... | |
| virtual const EcXmlComponentMap & | attributeComponentMap () |
| get a reference to the component attribute map | |
| virtual const EcXmlSpecialDescriptorMap & | specialDescriptorMap () |
| get a reference to the special-descriptor map | |
| virtual void | registerComponentDescriptor (const EcToken &xmlToken, const EcToken &descriptorToken, const EcString &descriptorString) |
| register an XML token-string descriptor More... | |
| virtual const EcXmlTokenStringDescriptorMapMap & | tokenStringDescriptorMap () |
| get a reference to the XML token-string descriptor map | |
| virtual EcBoolean | hasChildren () const |
| return EcTrue if there are children components or EcFalse if an empty element. | |
| virtual EcBoolean | hasAttributes () const |
| return EcTrue if there are attributes in the element. | |
| Public Member Functions inherited from EcXmlObject | |
| ECDECLARE_BIGFOUR (EcXmlObject) | |
| 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 | |
Protected Attributes | |
| EcManipulationScriptSimpleState | m_ScriptState |
| Manipulation script state. | |
| EcXmlBoolean | m_SingleStepFlag |
| Flag indicating whether to run in single-step mode. | |
| EcXmlStringStringMap | m_RoleObjectRoleMap |
| Map of object roles keyed by role. | |
| EcXmlStringStringMap | m_ManualPauseMessageMap |
| Map of manual pause messages keyed by uuid. | |
| EcSimpleIssues | m_DirectorIssues |
| director issues | |
| Protected Attributes inherited from EcXmlCompoundType | |
| EcXmlComponentMap * | m_pComponentMap |
| EcXmlComponentMap * | m_pAttributeComponentMap |
| EcXmlSpecialDescriptorMap * | m_pSpecialDescriptorMap |
| EcXmlTokenStringDescriptorMapMap * | m_pComponentMapTokenStringDescriptor |
| Protected Attributes inherited from EcXmlObject | |
| EcU8 | m_State |
| the state of the object - eight boolean flags | |
Friends | |
| class | EcManipulationDirector |
Additional Inherited Members | |
| Public Types inherited from EcXmlCompoundType | |
| enum | { READONLYCOMPONENT = 0, READONLYATTRIBUTE } |
| special-descriptor codes More... | |
| Protected Member Functions inherited from EcXmlCompoundType | |
| virtual EcBoolean | readValueFromToken (const EcToken &token, EcXmlReader &stream) |
| virtual EcBoolean | readValueFromSpecialToken (const EcToken &token, EcXmlReader &stream) |
| read value from unregistered token | |
| virtual EcBoolean | readAttributeFromToken (const EcToken &token, EcXmlReader &stream) |
| virtual EcXmlComponentMap * | newComponentMap () const |
| allocate a new componentMap | |
| virtual EcXmlSpecialDescriptorMap * | newSpecialDescriptorMap () |
| allocate a new specialDescriptorsMap | |
| virtual EcXmlTokenStringDescriptorMapMap * | newTokenStringDescriptorMap () |
| allocate a new tokenStringDescriptorsMap | |
| virtual void | createComponentMap () const |
| create component map | |
| virtual void | createAttributeComponentMap () |
| create attribute component map | |
| virtual void | createSpecialDescriptorMap () |
| create special-descriptors map | |
| virtual void | createTokenStringDescriptorMap () |
| create token-string descriptor map | |
| virtual EcBoolean | isReadOnlyComponent (const EcToken token) const |
| check to see if the token corresponds to a read-only component | |
| virtual EcBoolean | isReadOnlyAttribute (const EcToken token) const |
| check to see if the token corresponds to a read-only attribute | |
| virtual EcXmlObject * | libraryAttribute () |
| 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 | |
Holds EcManipulationDirector simple state information.
Definition at line 21 of file ecManipulationDirectorSimpleState.h.
