Inheritance diagram for DtRailMoveAlongTask:

Public Member Functions
	DtRailMoveAlongTask ()
	default constructor
	DtRailMoveAlongTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtRailMoveAlongTask (const DtString &writeName, const DtRailMoveAlongTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtRailMoveAlongTask &	operator= (const DtRailMoveAlongTask &orig)
	assignment operator
virtual	~DtRailMoveAlongTask ()
virtual const DtSimTaskMessageType &	type () const
	Returns "rail-move-along".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this move-along task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setPath (const DtRwTemplatedListPtr< DtRwRailSegment > &segs)
	The path to be followed.
virtual DtRwTemplatedListPtr < DtRwRailSegment > &	path ()
virtual const DtRwTemplatedListPtr < DtRwRailSegment > &	path () const
virtual void	addSegmentToPath (const DtRailSegment &seg)
	Add a rail segment.
virtual void	addSegmentToPath (const DtRwRailSegment *seg)
virtual int	netRepSize () const
	Rreturns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	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 bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
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.
virtual char *	netRep ()
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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions.
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
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
DtRwTemplatedListPtr < DtRwRailSegment >	mySegments
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
char *	myNetRep
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.

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
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task.
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

File: railMoveAlongTask.h.

Class: DtRailMoveAlongTask DtRailMoveAlongTask represents a Move Along Route task for an entity to perform. It inherits read/writableness from SimTask, and includes the control point to move to. The string name of the route is specified as a parameter of the task. The route name refers to a DtVrfObject. A route is a control object that contains an ordered list of vertices that represent a path for the entity to follow. Entities that implement this task move to the first vertex, then move successively from one vertex to the next. The task is considered complete when the entity reaches the last vertex in the route.

Both individual and pseudo-aggregate entities implement this task. A pseudo-aggregate entity forwards the move-along task to its lead subordinate. All other subordinates in the pseudo-aggregate are tasked to follow in formation. The pseudo-aggregate considers the Move Along task complete for the pseudo-aggregate as a whole when its lead subordinate completes the task

task-type: DtRailMoveAlongType

parameters: route name - The string name of the route to be followed. To find the DtRoute object to which the name refers look up the name in the Object Manager.

Constructor & Destructor Documentation

DtRailMoveAlongTask::DtRailMoveAlongTask ( )

default constructor

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

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

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

copy constructor

virtual DtRailMoveAlongTask::~DtRailMoveAlongTask ( )

virtual

Member Function Documentation

const DtRailMoveAlongTask& DtRailMoveAlongTask::operator= ( const DtRailMoveAlongTask & orig )

assignment operator

virtual const DtSimTaskMessageType& DtRailMoveAlongTask::type ( ) const

virtual

Returns "rail-move-along".

Implements DtSimTask.

virtual DtSimTask* DtRailMoveAlongTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Creates a copy of this move-along task.

Implements DtSimTask.

virtual DtString DtRailMoveAlongTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtRailMoveAlongTask::setPath ( const DtRwTemplatedListPtr< DtRwRailSegment > & segs )

virtual

The path to be followed.

virtual DtRwTemplatedListPtr<DtRwRailSegment>& DtRailMoveAlongTask::path ( )

virtual

virtual const DtRwTemplatedListPtr<DtRwRailSegment>& DtRailMoveAlongTask::path ( ) const

virtual

virtual void DtRailMoveAlongTask::addSegmentToPath ( const DtRailSegment & seg )

virtual

Add a rail segment.

virtual void DtRailMoveAlongTask::addSegmentToPath ( const DtRwRailSegment * seg )

virtual

virtual int DtRailMoveAlongTask::netRepSize ( ) const

virtual

Rreturns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtRailMoveAlongTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtRailMoveAlongTask::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

static DtSimTask* DtRailMoveAlongTask::creator ( )

static

Member Data Documentation

DtRwTemplatedListPtr<DtRwRailSegment> DtRailMoveAlongTask::mySegments

protected

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

include/vrftasks/railMoveAlongTask.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation