class DtAggregatedMoveAlongPSR:

DtAggregatedMoveAlongPSR is a process state repository for the DtAggregatedMoveAlongController, which is the controller for Aggregate Level entities (vs. aggregates of Entity Level entities. The PSR for the latter is DtAggregateMoveAlongController.)

Inheritance diagram for DtAggregatedMoveAlongPSR:

[legend]

Public Member Functions
	DtAggregatedMoveAlongPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

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

virtual	~DtAggregatedMoveAlongPSR () override

DtAggregatedMoveAlongPSR &	operator= (const DtAggregatedMoveAlongPSR &orig)

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

virtual DtString	type () const override

virtual void	emptyRouteVertices ()

virtual DtLocalVectorIterator *	routeState () const

virtual void	setTaskStartPoint (const DtVector &loc)

virtual const DtVector &	taskStartPoint () const

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) override


virtual void	setWorldDestination (const DtVector &destination)

virtual const DtVector &	worldDestination () const


virtual void	setRoute (const DtUUID &route)

virtual DtSimObjectReference	route () const


virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)

virtual void	setRouteVertices (const DtLocalVertexList &routeVertices)

virtual const DtLocalVertexList &	routeVertices () const


virtual void	setReversePatrol (bool flag)

virtual bool	reversePatrol () const


virtual void	setRouteIsDiscovered (bool value)

virtual bool	routeIsDiscovered () const


virtual void	setCurrentVertex (int vertex)

virtual int	currentVertex () const

Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

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

const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)

virtual	~DtVrfProcessStateRepository () override

virtual bool	init ()

virtual bool	loadedFromMTL () const

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()

static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)

static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)

static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry=0)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwSimObjectReference	myRoute

DtLocalVectorIterator *	myRouteState

DtLocalVertexList	myVertices

DtRwInt	myCurrentVertex

DtRwVector	myTaskStartPoint

DtRwBoolean	myReverseFlag

DtRwVector	myWorldDestination


DtRwBoolean	myRouteIsDiscovered

Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject

bool	myLoadedFromMTL

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()

const DtSimObject *	vrfObject () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtAggregatedMoveAlongPSR::DtAggregatedMoveAlongPSR	(	DtLocalObject *	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 ( )

overridevirtual

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

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregatedMoveAlongPSR::type ( ) const

overridevirtual

Returns the string type of the repository, as defined in psrTypes.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::setRoute ( const DtUUID & route )

virtual

Get/set the name of the route DtSimObject to move along.Was: setRouteName.

virtual DtSimObjectReference DtAggregatedMoveAlongPSR::route ( ) const

virtual

Was: routeName.

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 successfully initialized.

virtual bool DtAggregatedMoveAlongPSR::routeIsDiscovered ( ) const

virtual

Sets whether the current task has been successfully 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::setTaskStartPoint ( const DtVector & loc )

virtual

The starting location of the task.

virtual const DtVector& DtAggregatedMoveAlongPSR::taskStartPoint ( ) const

virtual

virtual void DtAggregatedMoveAlongPSR::putSelf	(	std::string &	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtReaderWriter::appPath()`
	)

overridevirtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwSimObjectReference DtAggregatedMoveAlongPSR::myRoute

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.

DtRwVector DtAggregatedMoveAlongPSR::myTaskStartPoint

protected

The start point of the move, to determine the direction to the first route point.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/aggregatedMoveAlongPSR.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation