Actin®  Version 5.2.0
Software for Robotics Simulation and Control
EcManipulationSceneState Class Reference

Holds EcManipulationScene state information. More...

#include <ecManipulationSceneState.h>

Inheritance diagram for EcManipulationSceneState:
EcBaseManipulationSceneState EcBaseExpressionTreeElement EcXmlCompoundType EcXmlObject

Public Types

enum  WaitingState {
  NO_WAITING,
  WAITING,
  SIMULTANEOUS_WAITING,
  SIMULTANEOUS_WAITING_COMPLETE
}
 enumeration of waiting state
 
typedef EcXmlMapType< EcXmlString, EcManipulationSceneDirectionStateContainerVectorRoleDirectionStatesMap
 map of string to a vector of direction states
 
- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 

Public Member Functions

 EcManipulationSceneState ()
 default constructor
 
virtual ~EcManipulationSceneState ()
 destructor
 
 EcManipulationSceneState (const EcManipulationSceneState &orig)
 copy constructor
 
EcManipulationSceneStateoperator= (const EcManipulationSceneState &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationSceneState &orig) const
 equality operator
 
virtual EcBoolean equality (const EcXmlObject *other) const EC_OVERRIDE
 equality - virtual equality to an EcXmlObject pointer
 
virtual void registerComponents () EC_OVERRIDE
 register components with the parent
 
virtual EcReal progress () const EC_OVERRIDE
 get the progress of the scene
 
virtual EcU32 currentItemIndex () const EC_OVERRIDE
 get the index of the current item
 
virtual EcReal elapsedTime () const EC_OVERRIDE
 get the elapsed time of the scene
 
virtual void setElapsedTime (EcReal time)
 set the elapsed time of the scene
 
virtual const EcXmlStringU32MaproleActiveDirectionMap () const
 get the map of roles to active directions
 
virtual const EcManipulationSceneDirectionStateContainerVectorroleDirectionStates (const EcString &role) const EC_OVERRIDE
 return a pointer to the directions for a specified role
 
virtual EcBoolean setRoleDirectionStates (const EcString &role, const EcManipulationSceneDirectionStateContainerVector &directionStates)
 set the direction states for a specified role
 
virtual const RoleDirectionStatesMaproleDirectionStatesMap () const
 get the map of roles to direction states
 
virtual const EcXmlStringU32MaproleWaitingStatesMap () const
 get the map of roles to waiting states
 
virtual const EcTokentoken () const EC_OVERRIDE
 get the token
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone
 
virtual EcXmlObjectnewObject () const EC_OVERRIDE
 virtual new that returns an EcXmlObject
 
- Public Member Functions inherited from EcBaseManipulationSceneState
 EcBaseManipulationSceneState ()
 default constructor
 
virtual ~EcBaseManipulationSceneState ()
 destructor
 
 EcBaseManipulationSceneState (const EcBaseManipulationSceneState &orig)
 copy constructor
 
EcBaseManipulationSceneStateoperator= (const EcBaseManipulationSceneState &orig)
 assignment operator
 
EcBoolean operator== (const EcBaseManipulationSceneState &orig) const
 equality operator
 
virtual const EcSimpleIssuesmanipulationSceneIssues () const
 
- Public Member Functions inherited from EcBaseExpressionTreeElement
 EcBaseExpressionTreeElement ()
 default constructor
 
 EcBaseExpressionTreeElement (const EcXmlBaseVariableCompoundType *containerPointer)
 constructor given container pointer
 
virtual ~EcBaseExpressionTreeElement ()
 destructor
 
 EcBaseExpressionTreeElement (const EcBaseExpressionTreeElement &orig)
 copy constructor
 
EcBaseExpressionTreeElementoperator= (const EcBaseExpressionTreeElement &orig)
 assignment operator
 
EcBoolean operator== (const EcBaseExpressionTreeElement &orig) const
 equality operator
 
virtual const EcXmlBaseVariableCompoundTypecontainer () const
 gets the container
 
virtual void setContainer (const EcXmlBaseVariableCompoundType *container)
 sets the container
 
- 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 EcXmlComponentMapcomponentMap () 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 EcXmlComponentMapattributeComponentMap ()
 get a reference to the component attribute map
 
virtual const EcXmlSpecialDescriptorMapspecialDescriptorMap ()
 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 EcXmlTokenStringDescriptorMapMaptokenStringDescriptorMap ()
 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
 

Static Public Member Functions

static EcXmlObjectcreator ()
 static creator function
 
- Static Public Member Functions inherited from EcBaseManipulationSceneState
static const EcTokenclassToken ()
 token for this class
 

Protected Types

typedef std::pair< const EcManipulationDirection *, const EcManipulationSceneDirectionState * > ActiveManipulationPairType
 pair of direction pointer with associated state pointer
 
typedef std::map< EcString, ActiveManipulationPairTypeRoleActiveManipulationMapType
 map of string to ActiveManipulationPairType
 

Protected Attributes

RoleDirectionStatesMap m_RoleDirectionStatesMap
 Map of manipulation scene directions keyed by role.
 
EcXmlStringU32Map m_RoleActiveDirectionMap
 Map of active manipulation scene directions keyed by role.
 
EcXmlStringU32Map m_RoleWaitingStateMap
 Map of active manipulation scene waiting state keyed by role.
 
EcXmlStringU32Map m_RoleLastSingleStepCountMap
 Map of the last "single step count" keyed by role.
 
EcXmlReal m_Progress
 Progress of the scene (0.0 = not started, 1.0 = completed)
 
EcXmlU32 m_CurrentItemIndex
 Current index.
 
EcXmlReal m_ElapsedTime
 Time elapsed since the start of update of this scene in seconds.
 
EcStringVector m_ActiveRoles
 Vector of the currently active roles.
 
RoleActiveManipulationMapType m_RoleActiveManipulationMap
 map of role to active direction and state
 
std::vector< const EcManipulationActiveState * > m_ActiveStates
 active states for each active manipulator
 
EcReal m_StartTime
 start time for the scene
 
- Protected Attributes inherited from EcBaseManipulationSceneState
EcSimpleIssues m_ManipulationSceneIssues
 scene issues
 
- Protected Attributes inherited from EcBaseExpressionTreeElement
const EcXmlBaseVariableCompoundTypem_pContainer
 a pointer to the container
 
- Protected Attributes inherited from EcXmlCompoundType
EcXmlComponentMapm_pComponentMap
 
EcXmlComponentMapm_pAttributeComponentMap
 
EcXmlSpecialDescriptorMapm_pSpecialDescriptorMap
 
EcXmlTokenStringDescriptorMapMapm_pComponentMapTokenStringDescriptor
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 

Friends

class EcManipulationScene
 

Additional Inherited Members

- 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 EcXmlComponentMapnewComponentMap () const
 allocate a new componentMap
 
virtual EcXmlSpecialDescriptorMapnewSpecialDescriptorMap ()
 allocate a new specialDescriptorsMap
 
virtual EcXmlTokenStringDescriptorMapMapnewTokenStringDescriptorMap ()
 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 EcXmlObjectlibraryAttribute ()
 
- 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 EcManipulationScene state information.

Definition at line 26 of file ecManipulationSceneState.h.


The documentation for this class was generated from the following file:
Created by Energid Technologies www.energid.com
Copyright © 2016 Energid. All trademarks mentioned in this document are property of their respective owners.