DtMoveAlongTaskState Class Reference

DtMoveAlongTaskState; task state associated with a DtMoveAlongTaskState. More...

Inheritance diagram for DtMoveAlongTaskState:

Public Member Functions
	DtMoveAlongTaskState ()
	default constructor
	DtMoveAlongTaskState (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task state object 'put' itself, the writeName will preface the task.
	DtMoveAlongTaskState (const DtString &writeName, const DtMoveAlongTaskState &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtMoveAlongTaskState &	operator= (const DtMoveAlongTaskState &orig)
	assignment operator
virtual	~DtMoveAlongTaskState ()
virtual DtString	type () const
virtual DtSimTaskState *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual void	setCurrentVertex (int vertex)
	Set/get current vertex we are heading toward in route.
virtual int	currentVertex () const
	Set/get current vertex we are heading toward in route.
Public Member Functions inherited from DtSimTaskState
	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 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
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 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 *	creator ()
Static Public Member Functions inherited from DtSimTaskState
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.

Protected Attributes
DtRwInt	myCurrentVertex

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
Static Public Attributes inherited from DtSimTaskState
static DtSimTaskStateFactory *	myFactory
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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

DtMoveAlongTaskState; task state associated with a DtMoveAlongTaskState.

Constructor & Destructor Documentation

DtMoveAlongTaskState::DtMoveAlongTaskState

(

)

default constructor

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

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

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

copy constructor

virtual DtMoveAlongTaskState::~DtMoveAlongTaskState ( )

virtual

Member Function Documentation

const DtMoveAlongTaskState& DtMoveAlongTaskState::operator=

(

const DtMoveAlongTaskState &

orig

)

assignment operator

virtual DtString DtMoveAlongTaskState::type ( ) const

virtual

Returns

DtMoveAlongTaskStateType

Reimplemented from DtSimTaskState.

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

virtual

Returns

newly-created copy of this move-along-task-state object

Reimplemented from DtSimTaskState.

virtual DtString DtMoveAlongTaskState::stringRep ( ) const

virtual

Returns

a readable string representation of this task state object

virtual void DtMoveAlongTaskState::setCurrentVertex ( int  vertex )

virtual

Set/get current vertex we are heading toward in route.

Vertices are numbered starting at 0.

virtual int DtMoveAlongTaskState::currentVertex ( ) const

virtual

Set/get current vertex we are heading toward in route.

Vertices are numbered starting at 0.

static DtSimTaskState* DtMoveAlongTaskState::creator ( )

static

Member Data Documentation

DtRwInt DtMoveAlongTaskState::myCurrentVertex

protected

---

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

• include/vrftasks/moveAlongTaskState.h