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

Concrete implementation of EcManipulationSceneDirectionState for holding EcConditionalDirection state information. More...

#include <ecConditionalDirectionState.h>

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

Public Types

enum  {
  NO_FAILURE,
  PRE_CONDITION_FAILURE,
  PERSISTENT_CONDITION_FAILURE,
  POST_CONDITION_FAILURE,
  DIRECTION_FAILURE,
  PRE_CONDITION_EXCEPTION_FAILURE,
  POST_CONDITION_EXCEPTION_FAILURE,
  PERSISTENT_CONDITION_EXCEPTION_FAILURE,
  DIRECTION_EXCEPTION_FAILURE
}
 failure type enum
 
enum  Status {
  NotStarted = 0x00,
  PlayingPrecondition = 0x01,
  PreconditionCompletedSuccess = 0x02,
  PreconditionFailed = 0x04,
  PlayingDirection = 0x08,
  DirectionCompletedSucsess = 0x10,
  DirectionFailed = 0x20,
  PersistentConditionFailed = 0x40,
  PersistentConditionPass = 0x80,
  PlayingPostCondition = 0x100,
  PostConditionCompletedSuccess = 0x200,
  PostConditionFailed = 0x400,
  PlayingPreConditionException = 0x0800,
  PreConditionExceptionSuccess = 0x1000,
  PreConditionExceptionFailed = 0x2000,
  PlayingPersistentconditionException = 0x4000,
  PersistentconditionExceptionSuccess = 0x8000,
  PersistentconditionExceptionFailed = 0x10000,
  PlayingPostconditionException = 0x20000,
  PostconditionExceptionSuccess = 0x40000,
  PostconditionExceptionFailed = 0x80000,
  PlayingDirectionException = 0x100000,
  DirectionExceptionSuccess = 0x200000,
  DirectionExceptionFailed = 0x400000
}
 conditional direction execution states
 
- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 

Public Member Functions

virtual void registerComponents () EC_OVERRIDE
 register components with the parent
 
EcU32 failureType () const
 get the failure type
 
EcU32 failureIndex () const
 get the failure index
 
EcU32 exceptionFailureIndex () const
 
const EcBasicDirectionIssuesVectorpreConditionIssues () const
 returns issues for the pre conditions based on current states
 
const EcBasicDirectionIssuesVectorpersistentConditionIssues () const
 returns issues for the persistent conditions based on current states
 
const EcBasicDirectionIssuesVectorpostConditionIssues () const
 returns issues for the post conditions based on current states
 
const EcManipulationSceneDirectionStateContainerVectorVectorpreConditionExceptionStates () const
 states for exception directions associated with pre condition based on current states
 
const EcManipulationSceneDirectionStateContainerVectorVectorpersistentConditionExceptionStates () const
 states for exception directions associated with persistent condition based on current states
 
const EcManipulationSceneDirectionStateContainerVectorVectorpostConditionExceptionStates () const
 states for exception directions associated with post condition based on current states
 
const EcManipulationSceneDirectionStateContainerVectorVectordirectionExceptionStates () const
 states for exception directions associated with directions based on current states
 
const EcManipulationSceneDirectionStateContainerVectordirectionStates () const
 states for directions based on current states
 
- Public Member Functions inherited from EcManipulationDirectionState
 EcManipulationDirectionState ()
 default constructor
 
virtual ~EcManipulationDirectionState ()
 destructor
 
 EcManipulationDirectionState (const EcManipulationDirectionState &orig)
 copy constructor
 
EcManipulationDirectionStateoperator= (const EcManipulationDirectionState &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationDirectionState &orig) const
 equality operator
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone - a virtual constructor to an EcXmlObject pointer
 
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
 
EcReal elapsedTime () const
 get the elapsed time of direction
 
void setElapsedTime (EcReal time)
 set the elapsed time of direction
 
virtual const EcTokentoken () const EC_OVERRIDE
 return a string token
 
virtual EcReal startTime () const
 
virtual void setStartTime (const EcReal &startTime)
 
virtual void setElapsedTime (const EcXmlReal &ElapsedTime)
 
- Public Member Functions inherited from EcManipulationSceneDirectionState
 EcManipulationSceneDirectionState ()
 default constructor
 
virtual ~EcManipulationSceneDirectionState ()
 destructor
 
 EcManipulationSceneDirectionState (const EcManipulationSceneDirectionState &orig)
 copy constructor
 
EcManipulationSceneDirectionStateoperator= (const EcManipulationSceneDirectionState &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationSceneDirectionState &orig) const
 equality operator
 
const EcBasicDirectionIssuesdirectorIssues () const
 returns director issues
 
virtual void addErrorString (const EcString &errString)
 adds the error string
 
void addErrorString (const EcStringVector &errString)
 
- 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 EcManipulationDirectionState
static const EcTokenclassToken ()
 token for this class
 
static EcXmlObjectcreator ()
 static creator function
 
- Static Public Member Functions inherited from EcManipulationSceneDirectionState
static const EcTokenclassToken ()
 token for this class
 
static EcXmlObjectcreator ()
 static creator function
 

Protected Attributes

EcXmlBoolean m_PreConditionsChecked
 flag indicating if the preconditions have been checked
 
EcXmlEnumU32 m_FailureType
 enumeration indicating the failure type
 
EcXmlU32 m_FailureIndex
 index of the failure
 
EcXmlU32 m_ExceptionFailureIndex
 failure index for exception
 
EcXmlU32 m_Status
 Conditional direction indicates the differenet possible state.
 
EcXmlBoolean m_ActiveDirectionIsComplete
 flag indicating if the current active direction is complete
 
EcXmlU32 m_ActiveDirectionIndex
 index of the current active direction
 
EcManipulationSceneDirectionStateContainerVectorVector m_PreConditionExceptionStates
 states for exception directions to execute on precondition failure
 
EcManipulationSceneDirectionStateContainerVectorVector m_PersistentConditionExceptionStates
 states for exception directions to execute on persistent condition failure
 
EcManipulationSceneDirectionStateContainerVectorVector m_PostConditionExceptionStates
 states for exception directions to execute on postcondition failure
 
EcManipulationSceneDirectionStateContainerVector m_DirectionStates
 states for directions to execute during the nominal execution
 
EcManipulationSceneDirectionStateContainerVectorVector m_DirectionExceptionStates
 states exception directions to execute on direction failure
 
EcBasicDirectionIssuesVector m_PreConditionIssues
 issues for the pre conditions based on current states
 
EcBasicDirectionIssuesVector m_PersistentConditionIssues
 issues for the persistent conditions based on current states
 
EcBasicDirectionIssuesVector m_PostConditionIssues
 issues for the persistent conditions based on current states
 
EcXmlReal m_Progress
 progress of the direction (0.0 = not started, 1.0 = completed)
 
const EcManipulationDirectionm_pActiveDirection
 currently-active direction
 
EcManipulationSceneDirectionStatem_pActiveDirectionState
 state for currently-active direction
 
- Protected Attributes inherited from EcManipulationDirectionState
EcXmlReal m_ElapsedTime
 elapsed time of direction
 
EcReal m_StartTime
 start time used to calculate elapsed time
 
- Protected Attributes inherited from EcManipulationSceneDirectionState
EcBasicDirectionIssues m_DirectionIssues
 direction 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 EcConditionalDirection
 
class EcExceptionDirection
 

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

Concrete implementation of EcManipulationSceneDirectionState for holding EcConditionalDirection state information.

Definition at line 24 of file ecConditionalDirectionState.h.


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