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

Concrete implementation of EcManipulationSceneDirectionSimpleState for conditional direction. More...

#include <ecConditionalDirectionSimpleState.h>

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

Public Types

enum  FailureType {
  NO_FAILURE,
  PRE_CONDITION_FAILURE,
  PERSISTENT_CONDITION_FAILURE,
  POST_CONDITION_FAILURE,
  DIRECTION_FAILURE,
  PRE_CONDITION_EXCEPTION_FAILURE,
  POST_CONDITION_EXCEPTION_FAILURE,
  PERSISTEN_CONDITION_EXCEPTION_FAILURE,
  DIRECTION_EXCEPTION_FAILURE
}
 Failure type enumeration.
 
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
 
virtual EcStringVector statusString () const EC_OVERRIDE
 get the status of directions in string
 
EcU32 getDirectionStatus () const
 returns the current execution status
 
EcU32 getFailureIndex () const
 returns the index of the failure
 
EcU32 getActiveDirectionIndex () const
 returns the index of the active direction
 
EcU32 exceptionFailureIndex () const
 
- Public Member Functions inherited from EcBasicDirectionSimpleState
 EcBasicDirectionSimpleState ()
 default constructor
 
virtual ~EcBasicDirectionSimpleState ()
 destructor
 
 EcBasicDirectionSimpleState (const EcBasicDirectionSimpleState &orig)
 copy constructor
 
EcBasicDirectionSimpleStateoperator= (const EcBasicDirectionSimpleState &orig)
 assignment operator
 
EcBoolean operator== (const EcBasicDirectionSimpleState &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
 
virtual EcReal progress () const EC_OVERRIDE
 get the progress
 
virtual void setProgress (EcReal value)
 set the progress
 
virtual EcReal elapsedTime () const EC_OVERRIDE
 get the elapsed time
 
virtual void setElapsedTime (EcReal value)
 set the elapsed time
 
virtual void setStatusString (const EcStringVector &stringVect)
 get the status of directions in string
 
const EcBasicDirectionIssuesdirectionIssues () const
 returns the direction issues
 
virtual const EcTokentoken () const EC_OVERRIDE
 return a string token
 
void setDirectorIssues (const EcBasicDirectionIssues &issues)
 sets the director issues
 
const EcBasicDirectionIssuesdirectorIssues () const
 
void setPath (const EcString &str)
 sets the path
 
const EcStringpath () const
 
void setStatusString (const EcString &string)
 
- Public Member Functions inherited from EcManipulationSceneDirectionSimpleState
 EcManipulationSceneDirectionSimpleState ()
 default constructor
 
virtual ~EcManipulationSceneDirectionSimpleState ()
 destructor
 
 EcManipulationSceneDirectionSimpleState (const EcManipulationSceneDirectionSimpleState &orig)
 copy constructor
 
EcManipulationSceneDirectionSimpleStateoperator= (const EcManipulationSceneDirectionSimpleState &orig)
 assignment operator
 
EcBoolean operator== (const EcManipulationSceneDirectionSimpleState &orig) const
 equality operator
 
- 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 EcBasicDirectionSimpleState
static const EcTokenclassToken ()
 token for this class
 
static EcXmlObjectcreator ()
 static creator function
 

Protected Attributes

EcXmlU32 m_FailureIndex
 index of the failure
 
EcXmlU32 m_ExceptionFailureIndex
 failure index for exception
 
EcXmlU32 m_Status
 Conditional direction indicates the differene possible state.
 
EcXmlU32 m_ActiveDirectionIndex
 index of the current active direction
 
EcXmlU32 m_PreConditionCount
 number of preconditions
 
EcXmlU32 m_PersistentConditionCount
 number of preconditions
 
EcXmlU32 m_DirectionsCount
 number of preconditions
 
EcXmlU32 m_PostConditionsCount
 number of preconditions
 
- Protected Attributes inherited from EcBasicDirectionSimpleState
EcXmlReal m_Progress
 Progress of the direction (0.0 = not started, 1.0 = completed)
 
EcXmlReal m_ElapsedTime
 Elapsed time of the direction in seconds.
 
EcXmlStringVector m_StatusStringVector
 Strings to elabrate the status of the direction.
 
EcBasicDirectionIssues m_DirectionIssues
 direction issues
 
EcXmlString m_Path
 Path if it is like action direction for direction reference.
 
- 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
 
class EcConditionalDirectionWidget
 

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 EcManipulationSceneDirectionSimpleState for conditional direction.

simple state for conditional direction.

Definition at line 22 of file ecConditionalDirectionSimpleState.h.


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