DtRailMoveAlongTask Class Reference

File: railMoveAlongTask.h. More...

Inheritance diagram for DtRailMoveAlongTask:

List of all members.

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 int	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.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwTemplatedListPtr < DtRwRailSegment >	mySegments

---

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 int 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