DtSimTaskState Class Reference

DtSimTaskState holds the current execution state of a given task. More...

Inheritance diagram for DtSimTaskState:

Public Member Functions
	DtSimTaskState ()
	default constructor
	DtSimTaskState (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task staet object 'put' itself, the write name will preface the task state object.
	DtSimTaskState (const DtString &writeName, const DtSimTaskState &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTaskState &	operator= (const DtSimTaskState &orig)
	assignment operator; same as copy constructor
virtual	~DtSimTaskState ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual DtString	type () const
	What kind of task state object am I? Returns a string indicating the kind of task state object( for example, “move-along-task-state”, Derived classes must implement this member function to return a unique string representing the type of task state.
virtual DtSimTaskState *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Make a copy of this task.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimTaskState *	createTaskState (DtlObjPtr mtlStream)
	Static functions.
static DtSimTaskState *	createTaskState (DtString taskStateType)
static void	addTaskStateCreatorFcn (const DtString &taskName, DtSimTaskStateCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskStateFactory *factory)
static DtSimTaskStateFactory *	factory ()
static bool	isTypeRegistered (DtString type)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Static Public Attributes
static DtSimTaskStateFactory *	myFactory

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

DtSimTaskState holds the current execution state of a given task.

DtSimTaskState is an abstract base class that represents the current execution state associated with a given DtSimTask. Derived classes hold details particular to a specific task. For example, for the DtMoveAlongTask there is a corresponding DtMoveAlongTaskState class that holds the current waypoint and direction of movement along the route. DtSimTaskState can be used in transferring responsibility for handling a task from one class to another (i.e. mult-resolution modeling), or in the context of suspending and resuming a task.

Constructor & Destructor Documentation

DtSimTaskState::DtSimTaskState

(

)

default constructor

DtSimTaskState::DtSimTaskState	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task staet object 'put' itself, the write name will preface the task state object.

DtSimTaskState::DtSimTaskState	(	const DtString &	writeName,
		const DtSimTaskState &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSimTaskState::~DtSimTaskState ( )

virtual

destructor

Member Function Documentation

const DtSimTaskState& DtSimTaskState::operator=

(

const DtSimTaskState &

orig

)

assignment operator; same as copy constructor

virtual bool DtSimTaskState::init ( )

virtual

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

virtual DtString DtSimTaskState::type ( ) const

virtual

What kind of task state object am I? Returns a string indicating the kind of task state object( for example, “move-along-task-state”, Derived classes must implement this member function to return a unique string representing the type of task state.

The set of standard task state types supplied with VR-Forces is in taskStateTypes.h.

Returns

DtBaseTaskStateType

Reimplemented in DtMoveAlongTaskState, DtPatrolBetweenPointsTaskState, DtPatrolRouteTaskState, DtWaitTaskState, and DtGenericTaskState.

virtual DtSimTaskState* DtSimTaskState::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Make a copy of this task.

Returns a newly allocated instance of a DtSimTaskState. Override this member function to return a pointer to a newly allocated instance of the derived class.

Reimplemented in DtMoveAlongTaskState, DtPatrolBetweenPointsTaskState, DtPatrolRouteTaskState, DtWaitTaskState, and DtGenericTaskState.

virtual void DtSimTaskState::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtSimTaskState::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

getData is just used to get us past the type in the data stream, since it's not actually stored.

static DtSimTaskState* DtSimTaskState::createTaskState ( DtlObjPtr  mtlStream )

static

Static functions.

Creates a new task state object, given a pointer to a MÄK Technologies LISP (MTL) stream. It first parses the stream to extract the type of task to create. Then it calls the task factory's create() member function with the given task type. This returns a new instance of the particular task type. The task's getData() member function is then called to retrieve the task parameters from the stream. The pointer to the new task is returned.

static DtSimTaskState* DtSimTaskState::createTaskState ( DtString  taskStateType )

static

static void DtSimTaskState::addTaskStateCreatorFcn ( const DtString &  taskName, DtSimTaskStateCreatorFcn  fcn  )

static

Adds a task creator member function to the task factory.

static void DtSimTaskState::setFactory ( DtSimTaskStateFactory *  factory )

static

static DtSimTaskStateFactory* DtSimTaskState::factory ( )

static

Returns

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static bool DtSimTaskState::isTypeRegistered ( DtString  type )

static

Member Data Documentation

DtSimTaskStateFactory* DtSimTaskState::myFactory

static

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/simTaskState.h