Actin  Version 5.5.2
Software for Robotics Simulation and Control
EcManipulationScript Class Reference

Organizes multiple manipulation scenes. More...

#include <ecManipulationScript.h>

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

Public Member Functions

 EcManipulationScript ()
 default constructor
 
virtual ~EcManipulationScript ()
 destructor
 
 EcManipulationScript (const EcManipulationScript &orig)
 copy constructor
 
EcManipulationScriptoperator= (const EcManipulationScript &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationScript &orig) const
 equality operator
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone - a virtual constructor to an EcXmlObject pointer
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read object from an XML stream
 
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
 
virtual EcBoolean add (const EcBaseManipulationScene &scene)
 add a scene to this script
 
virtual void clear ()
 clear this script of all scenes
 
virtual EcBoolean empty () const
 return true if there there are no scenes in this script
 
virtual const EcManipulationSceneContainerVectorscenes () const
 get the scenes contained in this script
 
virtual void setScenes (const EcManipulationSceneContainerVector &scenes)
 set the scenes contained in this script
 
virtual EcBoolean loopFlag () const
 get the flag indicating if the completed script should loop back to the beginning
 
virtual void setLoopFlag (EcBoolean flag)
 set the flag indicating if the completed script should loop back to the beginning
 
virtual EcU32 loopCount () const
 get the loop count or number of times that script will be executed
 
virtual void setLoopCount (EcU32 count)
 set the loop count or number of times that script should be executed
 
virtual EcStringVector primaryRoleNames (const EcManipulationDirector &director) const
 get a vector of primary role names that are referenced within this script
 
virtual EcStringVector primaryRoleNames (const EcDirectorObjectDirectory &objectDirectory) const
 get a vector of primary role names that are referenced within this script
 
virtual EcStringVector roleNames (const EcManipulationDirector &director) const
 get a vector of role names that are referenced within this script
 
virtual EcBoolean init (const EcManipulationDirector &director, EcManipulationScriptState &sstate) const
 initialize the script
 
virtual EcManipulationStatus::Enum update (EcReal time, const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, EcManipulationDirectorState &dstate, EcManipulationScriptState &sstate) const
 update the script
 
virtual void convert (const EcManipulationScriptState &sstate, EcManipulationScriptSimpleState &ssstate) const
 convert the manipulation script state
 
virtual void fastForward (const EcManipulationScriptSimpleState &ssstate, EcManipulationScriptState &sstate) const
 fast forward the manipulation script state
 
virtual const EcStringVectoractiveRoles (const EcManipulationScriptState &sstate) const
 determine the currently active roles
 
virtual const std::vector< const EcManipulationActiveState * > & activeStates (const EcManipulationScriptState &sstate) const
 get the active state to be used for each active manipulator
 
virtual EcReal progress (const EcManipulationScriptState &sstate) const
 get the overall progress of the script
 
virtual EcStringVector statusStrings (const EcManipulationScriptState &sstate, const EcString &separator) const
 determine the status string from each active manipulator
 
virtual EcReal elapsedTime (const EcManipulationScriptState &sstate) const
 get the elapsed time of the script
 
virtual void acceptDirectorVisitor (EcManipulationDirectorVisitor &visitor, EcDirectorObjectDirectory &dod, EcManipulationScriptState *pState=0)
 Accept a visitor.
 
virtual void traverseDirectorVisitor (EcManipulationDirectorVisitor &visitor, EcDirectorObjectDirectory &dod, EcManipulationScriptState *pState=0)
 Traverse through sub objects with visitor.
 
virtual void traverseDirectorVisitor (EcU32 index, EcManipulationDirectorVisitor &visitor, EcDirectorObjectDirectory &dod, EcManipulationScriptState *pState=0)
 Traverse through a specified sub object with visitor.
 
virtual void acceptDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName)
 
virtual void traverseDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName)
 
virtual void acceptDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
 
virtual void traverseDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
 
virtual const EcTokentoken () const EC_OVERRIDE
 get the token
 
EcBoolean hasDependency (const EcString &directionName, EcBoolean isFolder=EcFalse) const
 checks if the script contains a scene by name(path) sceneName
 
EcBoolean convertActionsToDirection (const EcString &actionPath=EcString())
 
- 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
 

Protected Attributes

EcManipulationSceneContainerVector m_SceneContainerVector
 Vector of manipulation scenes that define the script.
 
EcXmlBoolean m_LoopFlag
 Flag indicating if the completed script should loop back to the beginning.
 
EcXmlU32 m_LoopCount
 
EcManipulationSceneVector m_Scenes
 DEPRECATED used for reading old file formats.
 
- 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

- 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 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

Organizes multiple manipulation scenes.

Definition at line 35 of file ecManipulationScript.h.


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