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

Organizes multiple manipulation director objects into a directory hierarchy. More...

#include <ecDirectorObjectDirectory.h>

Inheritance diagram for EcDirectorObjectDirectory:
EcXmlCompoundType EcXmlObject

Public Types

typedef EcXmlMapType< EcXmlString, EcDirectorObjectDirectoryStringDirectoryMap
 map of string to EcDirectorObjectDirectory (subdirectories)
 
typedef EcXmlMapType< EcXmlString, EcDirectorObjectContainerStringObjectMap
 map of string to EcDirectorObjectContainer (objects in this directory)
 
- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 

Public Member Functions

 EcDirectorObjectDirectory ()
 default constructor
 
virtual ~EcDirectorObjectDirectory ()
 destructor
 
 EcDirectorObjectDirectory (const EcDirectorObjectDirectory &orig)
 copy constructor
 
EcDirectorObjectDirectoryoperator= (const EcDirectorObjectDirectory &orig)
 assignment operator
 
EcBoolean operator== (const EcDirectorObjectDirectory &orig) const
 equality operator
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read object from an XML stream
 
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 - virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const EC_OVERRIDE
 virtual new that returns an EcXmlObject
 
virtual EcBoolean empty () const
 return true if there there are no subdirectories or objects in this directory
 
virtual void clear ()
 clear this directory of all subdirectories and objects
 
virtual EcBoolean add (const EcString &aname, const EcManipulationSceneDirection &direction)
 add a direction
 
virtual EcBoolean add (const EcString &oname, const EcManipulationScript &script)
 add a script
 
virtual EcBoolean add (const EcString &oname, const EcManipulationScene &scene)
 
virtual EcBoolean add (const EcString &oname, const EcPose &pose)
 add a pose
 
virtual EcBoolean add (const EcString &oname, const EcDirectorObject &object)
 add an object
 
virtual EcBoolean add (const EcString &dname, const EcDirectorObjectDirectory &directory)
 add a subdirectory
 
virtual EcBoolean remove (const EcString &name)
 remove a object
 
virtual EcBoolean removeFolder (const EcString &folderName)
 remove a subdirectory
 
EcBoolean hasObjects () const
 return true if this directory has objects
 
const EcPosefindPose (const EcString &poseName) const
 get a pose from the directory
 
virtual const EcDirectorObjectobject (const EcString &oname) const
 get a pathplanner from the directory More...
 
EcBoolean hasSubdirectories () const
 return true if this directory has subdirectories
 
virtual const EcDirectorObjectDirectorysubdirectory (const EcString &dname) const
 get a subdirectory from this directory
 
EcStringVector directoryListing () const
 get a full listing of all directories included in this directory
 
EcStringVector subdirectoryListing () const
 get a listing of the subdirectories included in this directory
 
EcStringVector objectListing () const
 get a full listing of all objects included in this directory
 
EcStringVector subobjectListing () const
 get a listing of the subobjects included in this directory
 
virtual const EcTokentoken () const EC_OVERRIDE
 get the token
 
EcBoolean setData (const EcStringVector &pathVector, const EcDirectorObjectDirectory &newDod, EcU32 operationType)
 copy specific paths froma director object directory into this director object directory
 
void acceptDodLibraryVisitor (EcDodObjectVisitor &visitor)
 
void traverseDodLibraryVisitor (EcDodObjectVisitor &visitor)
 
void acceptDodReaderVisitor (EcDodReaderVisitor &visitor) const
 
void traverseDodReaderVisitor (EcDodReaderVisitor &visitor) const
 
EcStringVector getModifiedItems ()
 
EcBoolean dataConverted ()
 
- 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
 

Static Public Member Functions

static EcBoolean splitObjectName (const EcString &oname, EcString &subdirectoryName, EcString &objectName)
 split an object name into a subdirectory and object name
 
static EcBoolean splitDirectoryName (const EcString &dname, EcString &subdirectoryName, EcString &directoryName)
 split a directory name into a subdirectory and director name
 
static void loadFromFilesystem (EcDirectorObjectDirectory &dod, const EcString &directory)
 load a director object directory from the filesystem
 
static EcBoolean loadFromFilesystem (EcDirectorObjectDirectory &dod, const EcString &oname, const EcString &fileName)
 load a director object directory from the filesystem
 
static EcBoolean saveToFilesystem (const EcDirectorObjectDirectory &dod, const EcString &directory)
 save a director object directory to the filesystem
 

Protected Member Functions

EcDirectorObjectDirectorycreateSubdirectory (const EcString &dname)
 create a subdirectory
 
void directoryListing (EcStringVector &listing, const EcString &prefix="") const
 recursive directory listing
 
void objectListing (EcStringVector &listing, const EcString &prefix="") const
 recursive object listing
 
void traverse (const EcString &dirPath, const EcDirectorObjectDirectory &dod, EcDodObjectVisitor &visitor)
 traverse recursively to handle visitor
 
void traverse (const EcString &dirPath, const EcDirectorObjectDirectory &dod, EcDodReaderVisitor &visitor) const
 traverse recursively to handle visitor
 
EcDirectorObjectContainerobjectContainer (const EcString &oname)
 
void convertActionDirectionsToDirectionReference ()
 
void convertAllActionDirectionsToDirectionReference ()
 
- 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 ()
 

Protected Attributes

StringDirectoryMap m_SubdirectoryMap
 subdirectories of this directory
 
StringObjectMap m_ObjectMap
 objects located in this directory
 
- 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 EcManipulationDirector
 
class EcManipulationScript
 
class EcManipulationSceneReference
 

Additional Inherited Members

- 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 director objects into a directory hierarchy.

Definition at line 29 of file ecDirectorObjectDirectory.h.

Member Function Documentation

virtual const EcDirectorObject* EcDirectorObjectDirectory::object ( const EcString oname) const
virtual

get a pathplanner from the directory

get an object from this directory

Examples:
ecCirclePathExampleDirection.cpp.

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.