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

Concrete implementation of EcManipulationDirection for running EcManipulationAction directions from the director. More...

#include <ecActionDirection.h>

Inheritance diagram for EcActionDirection:
EcManipulationDirection EcManipulationSceneDirection EcBaseExpressionTreeElement EcXmlCompoundType EcXmlObject

Public Member Functions

 EcActionDirection ()
 default constructor
 
virtual ~EcActionDirection ()
 destructor
 
 EcActionDirection (const EcActionDirection &orig)
 copy constructor
 
EcActionDirectionoperator= (const EcActionDirection &orig)
 assignment operator
 
EcBoolean operator== (const EcActionDirection &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 - a virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const EC_OVERRIDE
 virtual new that returns an EcXmlObject
 
virtual const EcStringactionPath () const
 get the path of the desired action within the action directory
 
virtual void setActionPath (const EcString &path)
 set the path of the desired action within the action directory
 
virtual const EcDataMapactionParameters () const
 get the additional parameters to be used by the action
 
virtual void setActionParameters (const EcDataMap &parameters)
 set the additional parameters to be used by the action
 
virtual const EcString descriptor () const EC_OVERRIDE
 get the descriptor for this direction
 
virtual EcBoolean init (const EcManipulationDirector &director, const EcString &role, EcManipulationSceneDirectionStateContainer &dstateContainer) const EC_OVERRIDE
 initialize the direction
 
virtual EcManipulationStatus::Enum update (EcReal time, const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, const EcString &role, EcManipulationDirectorState &dstate, EcManipulationSceneDirectionState &sdstate) const EC_OVERRIDE
 update the direction
 
virtual void convert (const EcManipulationSceneDirectionStateContainer &dstateContainer, EcManipulationSceneDirectionSimpleStateContainer &sdstateContainer) const EC_OVERRIDE
 convert the direction state
 
virtual const EcManipulationActiveStateactiveState (const EcManipulationSceneDirectionState &dstate) const EC_OVERRIDE
 Return the active state, given the direction state.
 
virtual EcReal progress (const EcManipulationSceneDirectionState &dstate) const EC_OVERRIDE
 get the progress of this direction
 
EcInt32 currentItemAtPlay (const EcManipulationSceneDirectionState &dstate) const
 get the current item at play; this is not applicable for any action that is not listable like waypoint sequence
 
EcInt32 itemCount (const EcManipulationSceneDirectionState &dstate) const
 get the number of items within this direction; this is not applicable for any action that is not listable like waypoint sequence
 
virtual EcString statusString (const EcManipulationSceneDirectionState &dstate, const EcString &separator) const EC_OVERRIDE
 get the status string
 
virtual const EcTokentoken () const EC_OVERRIDE
 return a string token
 
virtual void acceptDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName) EC_OVERRIDE
 
virtual void traverseDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName) EC_OVERRIDE
 
EcManipulationSceneDirectionconvertToEquivalent () const EC_OVERRIDE
 
- Public Member Functions inherited from EcManipulationDirection
 EcManipulationDirection ()
 default constructor
 
virtual ~EcManipulationDirection ()
 destructor
 
 EcManipulationDirection (const EcManipulationDirection &orig)
 copy constructor
 
EcManipulationDirectionoperator= (const EcManipulationDirection &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationDirection &orig) const
 equality operator
 
virtual EcReal elapsedTime (const EcManipulationSceneDirectionState &dstate) const
 get the elapsed time of this direction
 
virtual EcBoolean isPauseCapable ()
 All the manipulation directions that can be pasued, need to implement the method and return true.
 
- Public Member Functions inherited from EcManipulationSceneDirection
 EcManipulationSceneDirection ()
 default constructor
 
virtual ~EcManipulationSceneDirection ()
 destructor
 
 EcManipulationSceneDirection (const EcManipulationSceneDirection &orig)
 copy constructor
 
EcManipulationSceneDirectionoperator= (const EcManipulationSceneDirection &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationSceneDirection &orig) const
 equality operator
 
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
 
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 direction
 
virtual const EcStringuuid () const
 get the universally unique identifier for this direction
 
virtual void setUuid (const EcString &uuid)
 set the universally unique identifier for this direction
 
virtual void clearUuids ()
 clear the uuid for this direction as well as any internally used directions
 
virtual void acceptDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
 
virtual void traverseDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
 
virtual EcBoolean handleLibraryEvent (const EcDodLibraryEventParams &param)
 All the Scene directions that allow dod visitor needs to implement.
 
virtual EcBoolean handleLibraryEvent (const EcDodLibraryEventParams &param) const
 All the Scene directions that allow dod visitor needs to implement.
 
virtual EcBoolean convertActionsToDirection (const EcString &path=EcString())
 converts the manipulation actions to directions
 
virtual EcBoolean needIntermediateConversion () 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 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 Attributes

EcXmlString m_ActionPath
 path of the desired action within the action directory
 
EcDataMap m_ActionParameters
 additional parameters to be used by the action
 
- Protected Attributes inherited from EcManipulationSceneDirection
EcXmlString m_Tag
 Tag used for referencing this direction.
 
EcXmlString m_Uuid
 universally unique identifier for this direction
 
- 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

- Public Types inherited from EcManipulationSceneDirection
enum  GroupCode {
  Motion = 0,
  Control = 1,
  StageDirection = 2,
  TimeDirection = 3,
  IODirection = 4,
  OtherDirection = 5,
  ExampleDirection = 6,
  HardwareDirection = 7,
  VarDirection = 8,
  CustomGroup_1 = 9,
  CustomGroup_2 = 10,
  NoGroup = 11
}
 direction execution states
 
- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 
- Protected Member Functions inherited from EcManipulationSceneDirection
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 ()
 
- 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

Concrete implementation of EcManipulationDirection for running EcManipulationAction directions from the director.

This class is Concrete implementation of EcManipulationDirection; it was used to run EcManipulationAction directions from the director. It cannot be used explicitly; but used to read old formated action directions, will be converted equivalent directionReferences

Definition at line 19 of file ecActionDirection.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.