EcAssignObjectRoleDirection Class Reference

Concrete implementation of EcStageDirection for selecting the role to use as the object in object-relative actions. More...

#include <ecAssignObjectRoleDirection.h>

Inheritance diagram for EcAssignObjectRoleDirection:

Collaboration diagram for EcAssignObjectRoleDirection:

Public Member Functions
virtual void	registerComponents () EC_OVERRIDE
	register components with the parent
const EcString &	objectRole () const
	get the object role
void	setObjectRole (const EcString &objectRole)
	set the object role
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 assign object role direction
virtual EcBoolean	apply (const EcManipulationDirector &director, const EcManipulationDirectorUpdateParams &params, const EcString &role, EcManipulationDirectorState &dstate, EcManipulationSceneDirectionState &sdstate) const EC_OVERRIDE
	apply the assign object role direction
virtual void	convert (const EcManipulationSceneDirectionStateContainer &dstateContainer, EcManipulationSceneDirectionSimpleStateContainer &sdstateContainer) const EC_OVERRIDE
	convert the direction state
EcBoolean	handleLibraryEvent (const EcDodLibraryEventParams &param) EC_OVERRIDE
	All the Scene directions that allow dod visitor needs to implement.
EcBoolean	handleLibraryEvent (const EcDodLibraryEventParams &param) const EC_OVERRIDE
	All the Scene directions that allow dod visitor needs to implement.
Public Member Functions inherited from EcStageDirection
	EcStageDirection ()
	default constructor
virtual	~EcStageDirection ()
	destructor
	EcStageDirection (const EcStageDirection &orig)
	copy constructor
EcStageDirection &	operator= (const EcStageDirection &orig)
	assignment operator
EcBoolean	operator== (const EcStageDirection &orig) const
	equality operator
Public Member Functions inherited from EcManipulationSceneDirection
	EcManipulationSceneDirection ()
	default constructor
virtual	~EcManipulationSceneDirection ()
	destructor
	EcManipulationSceneDirection (const EcManipulationSceneDirection &orig)
	copy constructor
EcManipulationSceneDirection &	operator= (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 EcString &	tag () 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 EcString &	uuid () 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	acceptDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName)
virtual void	traverseDodLibraryVisitor (EcDodObjectVisitor &visitor, const EcString &objectName)
virtual void	acceptDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
virtual void	traverseDodReaderVisitor (EcDodReaderVisitor &visitor, const EcString &objectName) const
virtual EcBoolean	convertActionsToDirection (const EcString &path=EcString())
	converts the manipulation actions to directions
virtual EcBoolean	needIntermediateConversion () const
virtual EcManipulationSceneDirection *	convertToEquivalent () 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
EcBaseExpressionTreeElement &	operator= (const EcBaseExpressionTreeElement &orig)
	assignment operator
EcBoolean	operator== (const EcBaseExpressionTreeElement &orig) const
	equality operator
virtual const EcXmlBaseVariableCompoundType *	container () 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 EcXmlComponentMap &	componentMap () 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 EcXmlComponentMap &	attributeComponentMap ()
	get a reference to the component attribute map
virtual const EcXmlSpecialDescriptorMap &	specialDescriptorMap ()
	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 EcXmlTokenStringDescriptorMapMap &	tokenStringDescriptorMap ()
	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 EcXmlObject *	clone () const =0
	clone
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
virtual EcBoolean	equality (const EcXmlObject *other) const =0
	equality - a virtual equality to an EcXmlObject pointer
virtual EcXmlObject *	newObject () const =0
	creates new object - a virtual new to an EcXmlObject pointer
virtual const EcToken &	token () const =0
	gets the xml token used for writing out.

Static Public Member Functions
static EcXmlObject *	creator ()
	static creator function

Protected Attributes
EcXmlString	m_ObjectRole
	the object role
Protected Attributes inherited from EcManipulationSceneDirection
EcXmlEmbeddedString	m_Tag
	Tag used for referencing this direction.
EcXmlString	m_Uuid
	universally unique identifier for this direction
Protected Attributes inherited from EcBaseExpressionTreeElement
const EcXmlBaseVariableCompoundType *	m_pContainer
	a pointer to the container
Protected Attributes inherited from EcXmlCompoundType
EcXmlComponentMap *	m_pComponentMap
EcXmlComponentMap *	m_pAttributeComponentMap
EcXmlSpecialDescriptorMap *	m_pSpecialDescriptorMap
EcXmlTokenStringDescriptorMapMap *	m_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 EcXmlComponentMap *	newComponentMap () const
	allocate a new componentMap
virtual EcXmlSpecialDescriptorMap *	newSpecialDescriptorMap ()
	allocate a new specialDescriptorsMap
virtual EcXmlTokenStringDescriptorMapMap *	newTokenStringDescriptorMap ()
	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 EcXmlObject *	libraryAttribute ()
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 EcStageDirection for selecting the role to use as the object in object-relative actions.

Definition at line 18 of file ecAssignObjectRoleDirection.h.

---

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

• ecAssignObjectRoleDirection.h