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

Organizes manipulation scene directions for multiple manipulator roles. More...

#include <ecManipulationScene.h>

Inheritance diagram for EcManipulationScene:
EcBaseManipulationScene EcBaseExpressionTreeElement EcXmlCompoundType EcXmlObject

Public Types

typedef EcStringManipulationSceneDirectionContainerVectorMap RoleDirectionsMap
 map of string to a vector of direction containers
 
typedef EcU32EcManipulationSceneCueVectorMap DirectionCuesMap
 map of direction index to a vector of cues
 
typedef EcStringDirectionCuesMapMap RoleCuesMap
 map of string to DirectionCuesMap;
 
- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 

Public Member Functions

 EcManipulationScene ()
 default constructor
 
virtual ~EcManipulationScene ()
 destructor
 
 EcManipulationScene (const EcManipulationScene &orig)
 copy constructor
 
EcManipulationSceneoperator= (const EcManipulationScene &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationScene &orig) const
 equality operator
 
virtual EcXmlObjectclone () 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 EcXmlObjectnewObject () const EC_OVERRIDE
 virtual new that returns an EcXmlObject
 
EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read object from an XML stream
 
virtual EcBoolean empty () const
 return true if there there are no roles or directions in this scene
 
virtual void clear ()
 clear this scene of all roles and directions
 
virtual void merge (const EcManipulationScene &scene)
 merge a scene into this scene
 
virtual EcBoolean add (const EcString &role, const EcManipulationSceneDirection &direction)
 add a direction
 
virtual EcBoolean add (const EcString &role, const EcManipulationSceneDirectionContainer &direction)
 add a direction
 
virtual EcBoolean add (const EcString &role, EcU32 directionIndex, const EcManipulationSceneCue &cue)
 add a cue
 
virtual const DirectionCuesMaproleCues (const EcString &role) const
 return a pointer to the cues for a specified role
 
virtual const RoleCuesMaproleCuesMap () const
 get the map of roles to cues
 
virtual EcBoolean setRoleCuesMap (const RoleCuesMap &map)
 set the map of roles to cues
 
virtual const EcManipulationSceneDirectionContainerVectorroleDirections (const EcString &role) const
 return a pointer to the directions for a specified role
 
virtual EcBoolean setRoleDirections (const EcString &role, const EcManipulationSceneDirectionContainerVector &directions)
 set the directions for a specified role
 
virtual EcBoolean addRole (const EcString &role)
 add role to the scene
 
virtual EcBoolean removeRole (const EcString &role)
 
virtual EcBoolean renameRole (const EcString &oldRoleName, const EcString &newRoleName)
 
virtual const RoleDirectionsMaproleDirectionsMap () const
 get the map of roles to directions
 
virtual EcBoolean setRoleDirectionsMap (const RoleDirectionsMap &map)
 set the map of roles to directions
 
virtual EcStringVector primaryRoleNames () const
 get a vector of primary role names that are referenced within this scene
 
virtual EcStringVector roleNames (const EcManipulationDirector &director) const EC_OVERRIDE
 get a vector of role names that are referenced within this scene
 
EcStringVector roleNames () const
 
virtual EcStringVector primaryRoleNames (const EcManipulationDirector &director) const EC_OVERRIDE
 
virtual EcStringVector primaryRoleNames (const EcDirectorObjectDirectory &objectDirectory) const EC_OVERRIDE
 
virtual EcBoolean init (const EcManipulationDirector &director, EcManipulationSceneStateContainer &sstateContainer) const EC_OVERRIDE
 initialize the scene
 
virtual EcManipulationStatus::Enum update (EcReal time, const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, EcManipulationDirectorState &dstate, EcBaseManipulationSceneState &bsstate) const EC_OVERRIDE
 update the scene
 
virtual void convert (const EcManipulationSceneStateContainer &sstateContainer, EcManipulationSceneSimpleState &ssstate) const EC_OVERRIDE
 convert the manipulation scene state
 
virtual void fastForward (const EcManipulationSceneSimpleState &ssstate, EcBaseManipulationSceneState &bsstate) const EC_OVERRIDE
 fast forward the manipulation scene state
 
virtual const EcStringVectoractiveRoles (const EcBaseManipulationSceneState &bsstate) const EC_OVERRIDE
 get the currently active roles
 
virtual const std::vector< const EcManipulationActiveState * > & activeStates (const EcBaseManipulationSceneState &bsstate) const EC_OVERRIDE
 get the active state to be used for each active manipulator
 
virtual EcReal progress (const EcManipulationSceneState &sstate) const
 get the overall progress of the scene
 
virtual EcStringVector statusStrings (const EcBaseManipulationSceneState &bsstate, const EcString &separator) const EC_OVERRIDE
 determine the status string from each active manipulator
 
virtual void acceptDirectorVisitor (EcManipulationDirectorVisitor &visitor, EcDirectorObjectDirectory &dod, EcBaseManipulationSceneState *pBaseState) EC_OVERRIDE
 Accept a visitor.
 
void acceptDirectorVisitor (EcManipulationDirectorVisitor &visitor, EcManipulationSceneState *pState)
 
virtual void acceptDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName) EC_OVERRIDE
 
virtual void traverseDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName)
 
virtual void acceptDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const EC_OVERRIDE
 
virtual void traverseDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
 
EcBoolean convertActionsToDirection (const EcString &path=EcString())
 
virtual EcBoolean handleLibraryEvent (const EcDodLibraryEventParams &param) const
 All the Scene directions that allow dod visitor needs to implement.
 
virtual const EcTokentoken () const EC_OVERRIDE
 get the token
 
EcBoolean hasDependency (const EcString &directionName, EcBoolean isFolder=EcFalse) const
 checks if the scene contains a direction by name(path) directioName for any of it's roles
 
void clearUuids ()
 clears the UUID's of all directions contained in the scene, required when we make a copy of the scene and reuse it
 
- Public Member Functions inherited from EcBaseManipulationScene
 EcBaseManipulationScene ()
 default constructor
 
virtual ~EcBaseManipulationScene ()
 destructor
 
 EcBaseManipulationScene (const EcBaseManipulationScene &orig)
 copy constructor
 
EcBaseManipulationSceneoperator= (const EcBaseManipulationScene &orig)
 assignment operator
 
EcBoolean operator== (const EcBaseManipulationScene &orig) const
 equality operator
 
virtual const EcStringtag () const
 get the tag used for referencing this direction
 
virtual void setTag (const EcString &tag)
 set the tag used for referencing this scene
 
virtual EcString displayIconTag () 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 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 const EcTokenclassToken ()
 token for this class
 
static EcXmlObjectcreator ()
 static creator function
 

Protected Member Functions

virtual EcBoolean addCueImpl (const EcString &role, EcU32 directionIndex, const EcManipulationSceneCue &cue)
 add a cue to a specified direction
 
virtual void calculateProgress (EcManipulationSceneState &sstate) const
 calculate the progress
 
virtual EcBoolean initRole (const EcXmlString &roleKey, const EcManipulationDirector &director, EcManipulationSceneState &sstate) const
 initialize a role
 
virtual EcBoolean isWaiting (const EcXmlString &roleKey, EcU32 directionIndex, EcManipulationSceneState &sstate) const
 test to see if a specific direction is waiting
 
virtual EcManipulationStatus::Enum updateRole (EcReal time, const EcXmlString &roleKey, const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, EcManipulationDirectorState &dstate, EcManipulationSceneState &sstate) const
 update a role
 
virtual void clearUuidForRole (const EcXmlString &roleKey)
 
- Protected Member Functions inherited from EcBaseManipulationScene
void checkUuid () const
 
- 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 ()
 

Protected Attributes

RoleDirectionsMap m_RoleDirectionsMap
 Map of manipulation scene directions keyed by role.
 
RoleCuesMap m_RoleCuesMap
 Map of manipulation cues keyed by role.
 
EcXmlString m_TagOld
 Tag used for referencing this scene.
 
- Protected Attributes inherited from EcBaseManipulationScene
EcXmlString m_Tag
 Tag used for referencing this scene.
 
- 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
 

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

Organizes manipulation scene directions for multiple manipulator roles.

Definition at line 41 of file ecManipulationScene.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.