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

Container for direction conditions. More...

#include <ecDirectionConditionContainer.h>

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

Public Member Functions

 EcDirectionConditionContainer ()
 default constructor
 
virtual ~EcDirectionConditionContainer ()
 destructor
 
 EcDirectionConditionContainer (const EcDirectionConditionContainer &orig)
 copy constructor
 
EcDirectionConditionContaineroperator= (const EcDirectionConditionContainer &orig)
 assignment operator
 
EcBoolean operator== (const EcDirectionConditionContainer &orig) const
 equality operator
 
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 EcTokentoken () const EC_OVERRIDE
 return a string token
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone - a virtual constructor to an EcXmlObject pointer
 
virtual void registerComponentCreators () EC_OVERRIDE
 register all component creators
 
EcBoolean init (const EcManipulationDirector &director, const EcString &role, EcStringVector &failureReason) const
 validates the condition and initialises the condition
 
virtual EcBoolean test (const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, const EcString &role, const EcManipulationDirectorState &dstate) const
 test the condition container
 
virtual EcString text () const
 return a text description of the condition container
 
- Public Member Functions inherited from EcXmlVariableElementType< ElementType >
 ECXMLOBJECT (EcXmlVariableElementType)
 
virtual const ElementType * element () const
 gets a pointer to the top expression (const)
 
virtual ElementType * element ()
 gets a pointer to the top expression (nonconst)
 
virtual void setElement (const ElementType &element)
 sets the top expression through a copy
 
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
 
- Public Member Functions inherited from EcXmlBaseVariableCompoundType
 ECDECLARE_BIGFOUR (EcXmlBaseVariableCompoundType)
 
virtual EcBoolean xmlInit () EC_OVERRIDE
 xml-initialize
 
virtual void registerComponentCreator (const EcToken &token, EcXmlObjectCreator creator)
 register a single optional component
 
virtual EcXmlObjectnewObjectFromToken (const EcToken &token) const
 create a new object from its token
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const EC_OVERRIDE
 write this object to an XML stream
 
virtual const EcXmlStringVectoraddLibraries () const
 gets the library names (minus extension)
 
virtual void setAddLibraries (const EcXmlStringVector &addLibraries)
 sets the library names (minus extension)
 
virtual const EcXmlCreatorMapcreatorMap () const
 gets the creator map
 
- 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 EcDirectionConditionContainer nullObject ()
 null object
 

Additional Inherited Members

- Protected Member Functions inherited from EcXmlVariableElementType< ElementType >
virtual EcBoolean readValueFromToken (const EcToken &token, EcXmlReader &stream) EC_OVERRIDE
 
- Protected Member Functions inherited from EcXmlBaseVariableCompoundType
virtual void processLibraries ()
 process the add libraries
 
- Protected Attributes inherited from EcXmlVariableElementType< ElementType >
ElementType * m_pElement
 the top expression element
 
- Protected Attributes inherited from EcXmlBaseVariableCompoundType
EcXmlFactory m_XmlFactory
 A map holding the relationship between string labels and subcomponents.
 
EcXmlStringVector m_AddLibraries
 the arry of library names
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 
- 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

Container for direction conditions.

Definition at line 25 of file ecDirectionConditionContainer.h.


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