DtAggregatedMoveAlongPSR Class Reference

class DtTrueAggregateMoveAlongPSR: More...

Inheritance diagram for DtAggregatedMoveAlongPSR:

List of all members.

Public Member Functions
	DtAggregatedMoveAlongPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregatedMoveAlongPSR (const DtAggregatedMoveAlongPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAggregatedMoveAlongPSR ()
	destructor
DtAggregatedMoveAlongPSR &	operator= (const DtAggregatedMoveAlongPSR &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 the repository, as defined in procSRTypes.h.
virtual void	emptyRouteVertices ()
	Empty route vertices.
virtual DtLocalVectorIterator *	routeState () const
	Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to set myCurrentVertex from route state before writing.
virtual void	setWorldDestination (const DtVector &destination)
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual const DtVector &	worldDestination () const
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual void	setRouteName (const DtString &routeObjectName)
	Get/set the name of the route DtVrfObject to move along.
virtual const DtString &	routeName () const
	Get/set the name of the route DtVrfObject to move along.
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
	Set/get route vertices (local coordinates).
virtual void	setRouteVertices (const DtLocalVertexList &routeVertices)
	Set/get route vertices (local coordinates).
virtual const DtLocalVertexList &	routeVertices () const
	Set/get route vertices (local coordinates).
virtual void	setReversePatrol (bool flag)
	Get/set the reverse flag for patrolling (along route or between points).
virtual bool	reversePatrol () const
	Get/set the reverse flag for patrolling (along route or between points).
virtual void	setRouteIsDiscovered (bool value)
virtual bool	routeIsDiscovered () const
virtual void	setCurrentVertex (int vertex)
virtual int	currentVertex () const
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Attributes
DtRwString	myRouteName
	If tasked() is true, this is the name of the route object we're moving to.
DtLocalVectorIterator *	myRouteState
	Route state used to get info about the current route we're trying to follow (e.g.
DtLocalVertexList	myVertices
	my copy of the current route
DtRwInt	myCurrentVertex
	Read/write variables to capture route state.
DtRwBoolean	myReverseFlag
	From DtGroundPatrolRouteController (gndPtrlRtCtl.h)
DtRwVector	myWorldDestination
	World point for move to location tasks.
DtRwBoolean	myRouteIsDiscovered

---

Detailed Description

class DtTrueAggregateMoveAlongPSR:

Instances of DtTrueAggregateMoveAlongPSR are used to hold the shared/checkpointable data for a DtTrueAggregateMoveAlongController.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtAggregatedMoveAlongPSR::~DtAggregatedMoveAlongPSR

(

)

[virtual]

destructor

---

Member Function Documentation

DtAggregatedMoveAlongPSR& DtAggregatedMoveAlongPSR::operator=

(

const DtAggregatedMoveAlongPSR &

orig

)

assignment operator

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

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregatedMoveAlongPSR::type

(

)

const [virtual]

Returns the string type of the repository, as defined in procSRTypes.h.

(DtTrueAggregateMoveAlongPSRType).

Implements DtVrfProcessStateRepository.

virtual void DtAggregatedMoveAlongPSR::setWorldDestination

(

const DtVector &

destination

)

[virtual]

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.

This point is only valid for that task and is set in world (geocentric) coordinates

virtual const DtVector& DtAggregatedMoveAlongPSR::worldDestination

(

)

const [virtual]

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.

This point is only valid for that task and is set in world (geocentric) coordinates

virtual void DtAggregatedMoveAlongPSR::setRouteName

(

const DtString &

routeObjectName

)

[virtual]

Get/set the name of the route DtVrfObject to move along.

virtual const DtString& DtAggregatedMoveAlongPSR::routeName

(

)

const [virtual]

Get/set the name of the route DtVrfObject to move along.

virtual void DtAggregatedMoveAlongPSR::setRouteVertices

(

const DtLocalVectorIterator &

routeIterator

)

[virtual]

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual void DtAggregatedMoveAlongPSR::setRouteVertices

(

const DtLocalVertexList &

routeVertices

)

[virtual]

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual const DtLocalVertexList& DtAggregatedMoveAlongPSR::routeVertices

(

)

const [virtual]

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual void DtAggregatedMoveAlongPSR::emptyRouteVertices

(

)

[virtual]

Empty route vertices.

virtual DtLocalVectorIterator* DtAggregatedMoveAlongPSR::routeState

(

)

const [virtual]

Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).

virtual void DtAggregatedMoveAlongPSR::setReversePatrol

(

bool

flag

)

[virtual]

Get/set the reverse flag for patrolling (along route or between points).

virtual bool DtAggregatedMoveAlongPSR::reversePatrol

(

)

const [virtual]

Get/set the reverse flag for patrolling (along route or between points).

virtual void DtAggregatedMoveAlongPSR::setRouteIsDiscovered

(

bool

value

)

[virtual]

Sets whether the current task has been sucessfully initialized

virtual bool DtAggregatedMoveAlongPSR::routeIsDiscovered

(

)

const [virtual]

Sets whether the current task has been sucessfully initialized

virtual void DtAggregatedMoveAlongPSR::setCurrentVertex

(

int

vertex

)

[virtual]

Sets current vertex we heading toward. Vertices are numbered starting from zero.

virtual int DtAggregatedMoveAlongPSR::currentVertex

(

)

const [virtual]

Sets current vertex we heading toward. Vertices are numbered starting from zero.

virtual void DtAggregatedMoveAlongPSR::putSelf	(	FILE *	fp,
		int	indentLevel = 0,
		bool	writeUnspecified = false,
		const DtFilename &	path = DtReaderWriter::appPath()
	)		[virtual]

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

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

Returns a newly created instance of this class.

---

Member Data Documentation

DtRwString DtAggregatedMoveAlongPSR::myRouteName [protected]

If tasked() is true, this is the name of the route object we're moving to.

DtLocalVectorIterator* DtAggregatedMoveAlongPSR::myRouteState [protected]

Route state used to get info about the current route we're trying to follow (e.g.

which vertex to move toward).

DtLocalVertexList DtAggregatedMoveAlongPSR::myVertices [protected]

my copy of the current route

DtRwInt DtAggregatedMoveAlongPSR::myCurrentVertex [protected]

Read/write variables to capture route state.

DtRwBoolean DtAggregatedMoveAlongPSR::myRouteIsDiscovered [protected]

From DtGroundMoveAlongController (gndMvAlgCtl.h)

Flag indicating whether route to follow has been discovered or not.

DtRwBoolean DtAggregatedMoveAlongPSR::myReverseFlag [protected]

From DtGroundPatrolRouteController (gndPtrlRtCtl.h)

DtRwVector DtAggregatedMoveAlongPSR::myWorldDestination [protected]

World point for move to location tasks.

---

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

• include/vrfobjcore/aggregatedMoveAlongPSR.h