DtConvoyPSR Class Reference

This is a process state repository for the DtConvoyController that stores the list of the names of currently tasked entities. More...

Inheritance diagram for DtConvoyPSR:

List of all members.

Public Types
typedef DtRwTemplatedListPtr < DtRwString >	DtRwSubordinateList
Public Member Functions
	DtConvoyPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtConvoyPSR (const DtConvoyPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtConvoyPSR ()
	destructor
DtConvoyPSR &	operator= (const DtConvoyPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of this process state repository, defined in procSRTypes.h.
virtual void	setPathPlanFlag (bool flag)
	Accessors, setters, checkers and utilities for private members.
virtual bool	pathPlanFlag () const
virtual void	setConvoyPhase (const DtString &phase)
virtual const DtString &	convoyPhase () const
virtual void	setDestination (const DtString &destinationObjectName)
virtual const DtString &	destination () const
virtual const DtRwSubordinateList &	subordinates () const
virtual void	addSubordinate (const DtString &objectName)
virtual void	removeSubordinate (const DtString &objectName)
virtual bool	isASubordinate (const DtString &objectName) const
virtual bool	isSubordinatesEmpty () const
virtual void	clearSubordinates ()
virtual void	addAwaitingTaskSubordinate (const DtString &objectName)
virtual void	removeAwaitingTaskSubordinate (const DtString &objectName)
virtual const DtString &	lastTaskedSubordinate () const
virtual const DtString &	firstAwaitingTaskSubordinate () const
virtual void	clearAwaitingTaskSubordinates ()
virtual bool	isAwaitingTaskSubordinatesEmpty () const
virtual void	setAssemblyPoint (const DtVector &assemblyPoint)
virtual const DtVector &	assemblyPoint () const
virtual void	setConvoyLeader (const DtString &name)
virtual const DtString &	convoyLeader () const
virtual void	setLeadOnDistance (const float distance)
virtual const float	leadOnDistance () const
virtual void	setFollowDistance (const float distance)
virtual const float	followDistance () const
virtual void	setLastGeneratedEntryRail (const DtRwRailSegment &entryRail)
virtual DtRwRailSegment *	lastGeneratedEntryRail ()
virtual void	setLastOrderedSpeed (const float speed)
virtual const float	lastOrderedSpeed () const
virtual void	addRailSegment (const DtRailSegment &railSegment)
virtual void	addRailSegment (const DtRwRailSegment &railSegment)
virtual void	addRailSegment (const DtRwRailSegment *railSegment)
virtual void	addRailSegmentToFront (const DtRwRailSegment *railSegment)
virtual DtRwRailSegment *	removeRailSegmentFromFront (bool autoDelete=true)
virtual void	setRailSegments (const DtRwRailSegmentList &segments)
virtual void	setRailSegments (const DtRailSegmentList &segments)
virtual const DtRwRailSegmentList &	railSegmentList () const
virtual void	clearRailSegments ()
virtual DtRailSegmentList *	railSegments ()
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Member Functions
void	clearTempRailList ()
	Deletes all rails on myTempListPtr, and clears the list.
Protected Attributes
DtRwBoolean	myPathPlanFlag
DtRwString	myConvoyPhase
DtRwString	myDestination
DtRwVector	myAssemblyPoint
DtRwString	myConvoyLeader
DtRwString	myLastTaskedSubordinate
DtRwReal	myLeadOnDistance
DtRwReal	myFollowDistance
DtRwReal	myLastOrderedSpeed
DtRwSubordinateList	mySubordinates
DtRwSubordinateList	myAwaitingTaskSubordinates
DtRwRailSegmentList	myRailSegments
DtRwRailSegment	myLastGeneratedEntryRail
DtRailSegmentList *	myTempListPtr
bool	myRegenerateTempRailList

---

Detailed Description

This is a process state repository for the DtConvoyController that stores the list of the names of currently tasked entities.

---

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwString> DtConvoyPSR::DtRwSubordinateList

---

Constructor & Destructor Documentation

DtConvoyPSR::DtConvoyPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtConvoyPSR::DtConvoyPSR	(	const DtConvoyPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtConvoyPSR::~DtConvoyPSR

(

)

[virtual]

destructor

---

Member Function Documentation

DtConvoyPSR& DtConvoyPSR::operator=

(

const DtConvoyPSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtConvoyPSR::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtConvoyPSR::type

(

)

const [virtual]

Returns the string type of this process state repository, defined in procSRTypes.h.

Returns "vrf-convoy-process-state-repository".

Implements DtVrfProcessStateRepository.

static DtVrfProcessStateRepository* DtConvoyPSR::creator	(	const DtString &	rwName,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Returns a newly created instance of this class.

virtual void DtConvoyPSR::setPathPlanFlag

(

bool

flag

)

[virtual]

Accessors, setters, checkers and utilities for private members.

virtual bool DtConvoyPSR::pathPlanFlag

(

)

const [virtual]

virtual void DtConvoyPSR::setConvoyPhase

(

const DtString &

phase

)

[virtual]

virtual const DtString& DtConvoyPSR::convoyPhase

(

)

const [virtual]

virtual void DtConvoyPSR::setDestination

(

const DtString &

destinationObjectName

)

[virtual]

virtual const DtString& DtConvoyPSR::destination

(

)

const [virtual]

virtual const DtRwSubordinateList& DtConvoyPSR::subordinates

(

)

const [virtual]

virtual void DtConvoyPSR::addSubordinate

(

const DtString &

objectName

)

[virtual]

virtual void DtConvoyPSR::removeSubordinate

(

const DtString &

objectName

)

[virtual]

virtual bool DtConvoyPSR::isASubordinate

(

const DtString &

objectName

)

const [virtual]

virtual bool DtConvoyPSR::isSubordinatesEmpty

(

)

const [virtual]

virtual void DtConvoyPSR::clearSubordinates

(

)

[virtual]

virtual void DtConvoyPSR::addAwaitingTaskSubordinate

(

const DtString &

objectName

)

[virtual]

virtual void DtConvoyPSR::removeAwaitingTaskSubordinate

(

const DtString &

objectName

)

[virtual]

virtual const DtString& DtConvoyPSR::lastTaskedSubordinate

(

)

const [virtual]

virtual const DtString& DtConvoyPSR::firstAwaitingTaskSubordinate

(

)

const [virtual]

virtual void DtConvoyPSR::clearAwaitingTaskSubordinates

(

)

[virtual]

virtual bool DtConvoyPSR::isAwaitingTaskSubordinatesEmpty

(

)

const [virtual]

virtual void DtConvoyPSR::setAssemblyPoint

(

const DtVector &

assemblyPoint

)

[virtual]

virtual const DtVector& DtConvoyPSR::assemblyPoint

(

)

const [virtual]

virtual void DtConvoyPSR::setConvoyLeader

(

const DtString &

name

)

[virtual]

virtual const DtString& DtConvoyPSR::convoyLeader

(

)

const [virtual]

virtual void DtConvoyPSR::setLeadOnDistance

(

const float

distance

)

[virtual]

virtual const float DtConvoyPSR::leadOnDistance

(

)

const [virtual]

virtual void DtConvoyPSR::setFollowDistance

(

const float

distance

)

[virtual]

virtual const float DtConvoyPSR::followDistance

(

)

const [virtual]

virtual void DtConvoyPSR::setLastGeneratedEntryRail

(

const DtRwRailSegment &

entryRail

)

[virtual]

virtual DtRwRailSegment* DtConvoyPSR::lastGeneratedEntryRail

(

)

[virtual]

virtual void DtConvoyPSR::setLastOrderedSpeed

(

const float

speed

)

[virtual]

virtual const float DtConvoyPSR::lastOrderedSpeed

(

)

const [virtual]

virtual void DtConvoyPSR::addRailSegment

(

const DtRailSegment &

railSegment

)

[virtual]

virtual void DtConvoyPSR::addRailSegment

(

const DtRwRailSegment &

railSegment

)

[virtual]

virtual void DtConvoyPSR::addRailSegment

(

const DtRwRailSegment *

railSegment

)

[virtual]

virtual void DtConvoyPSR::addRailSegmentToFront

(

const DtRwRailSegment *

railSegment

)

[virtual]

virtual DtRwRailSegment* DtConvoyPSR::removeRailSegmentFromFront

(

bool

autoDelete = true

)

[virtual]

virtual void DtConvoyPSR::setRailSegments

(

const DtRwRailSegmentList &

segments

)

[virtual]

virtual void DtConvoyPSR::setRailSegments

(

const DtRailSegmentList &

segments

)

[virtual]

virtual const DtRwRailSegmentList& DtConvoyPSR::railSegmentList

(

)

const [virtual]

virtual void DtConvoyPSR::clearRailSegments

(

)

[virtual]

virtual DtRailSegmentList* DtConvoyPSR::railSegments

(

)

[virtual]

void DtConvoyPSR::clearTempRailList

(

)

[protected]

Deletes all rails on myTempListPtr, and clears the list.

Non-virtual so it can be used from the destructor.

---

Member Data Documentation

DtRwBoolean DtConvoyPSR::myPathPlanFlag [protected]

DtRwString DtConvoyPSR::myConvoyPhase [protected]

DtRwString DtConvoyPSR::myDestination [protected]

DtRwVector DtConvoyPSR::myAssemblyPoint [protected]

DtRwString DtConvoyPSR::myConvoyLeader [protected]

DtRwString DtConvoyPSR::myLastTaskedSubordinate [protected]

DtRwReal DtConvoyPSR::myLeadOnDistance [protected]

DtRwReal DtConvoyPSR::myFollowDistance [protected]

DtRwReal DtConvoyPSR::myLastOrderedSpeed [protected]

DtRwSubordinateList DtConvoyPSR::mySubordinates [protected]

DtRwSubordinateList DtConvoyPSR::myAwaitingTaskSubordinates [protected]

DtRwRailSegmentList DtConvoyPSR::myRailSegments [protected]

DtRwRailSegment DtConvoyPSR::myLastGeneratedEntryRail [protected]

DtRailSegmentList* DtConvoyPSR::myTempListPtr [protected]

bool DtConvoyPSR::myRegenerateTempRailList [protected]

---

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

• include/vrfobjcore/convoyPSR.h