class DtRailPathControllerPSR:

This is the Process State Repository for the DtRailPathController component. It stores all necessary pieces of data for that component that must be restored on a scenario load.

Inheritance diagram for DtRailPathControllerPSR:

[legend]

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

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

virtual	~DtRailPathControllerPSR ()

DtRailPathControllerPSR &	operator= (const DtRailPathControllerPSR &orig)

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

virtual DtString	type () const

virtual void	clear ()

virtual void	clearPath ()


virtual const DtRwRailSegmentList &	pathList () const

virtual DtRwRailSegmentList &	pathList ()

virtual void	addSegmentToPath (const DtRailSegment &seg, bool appendToEnd=true)

virtual void	addRailSegments (DtRailSegmentList *)


virtual void	setDestination (const DtUUID &destination)

virtual DtSimObjectReference	destination () const

virtual bool	destinationSpecified () const

virtual void	unspecifyDestination ()


virtual void	setDestinationLocation (const DtVector &destinationLocation)

virtual DtVector	destinationLocation () const

virtual bool	destinationLocationSpecified () const

virtual void	unspecifyDestinationLocation ()


virtual void	setDebugPath (const DtUUID &)

virtual const DtRwSimObjectReference &	debugPath () const

virtual bool	debugPathSpecified () const

virtual void	unspecifyDebugPath ()

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 ()

virtual bool	init ()

virtual bool	loadedFromMTL () const

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

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)

virtual	~DtReaderWriter ()

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

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	wasUpdatedSince (DtTime t) 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
parameters
These parameters are available for setting in the OPD files. Parameter Name: debug-path-name Parameter Description: Stores the name of the generated route representing the path. Only if user has set the show debug route option to true in the descriptor. Deprecated. Only for backwards compatibility
DtRwSimObjectReference	myDebugPath

DtRwSimObjectReference	myDestination

DtRwVector	myDestinationLocation

DtRwRailSegmentList	myPathList

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

DtRailPathControllerPSR::DtRailPathControllerPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

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

copy constructor

virtual DtRailPathControllerPSR::~DtRailPathControllerPSR ( )

virtual

destructor

Member Function Documentation

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

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtRailPathControllerPSR::type ( ) const

virtual

Returns the string type of this process state repository.

Implements DtVrfProcessStateRepository.

virtual void DtRailPathControllerPSR::clear ( )

virtual

virtual void DtRailPathControllerPSR::clearPath ( )

virtual

virtual const DtRwRailSegmentList& DtRailPathControllerPSR::pathList ( ) const

virtual

The generated path the entity will follow once it gets to the route network entry point.

virtual DtRwRailSegmentList& DtRailPathControllerPSR::pathList ( )

virtual

The generated path the entity will follow once it gets to the route network entry point.

virtual void DtRailPathControllerPSR::addSegmentToPath	(	const DtRailSegment &	seg,
		bool	appendToEnd = `true`
	)

virtual

The generated path the entity will follow once it gets to the route network entry point.

virtual void DtRailPathControllerPSR::addRailSegments ( DtRailSegmentList * )

virtual

The generated path the entity will follow once it gets to the route network entry point.

virtual void DtRailPathControllerPSR::setDestination ( const DtUUID & destination )

virtual

Set/Get the name of the destination object. Was: setDestinationName.

virtual DtSimObjectReference DtRailPathControllerPSR::destination ( ) const

virtual

Was: destinationName.

virtual bool DtRailPathControllerPSR::destinationSpecified ( ) const

virtual

Return if the destination name is specified. (Setting a destination name will specify it)

virtual void DtRailPathControllerPSR::unspecifyDestination ( )

virtual

Make the destination name unspecified.

virtual void DtRailPathControllerPSR::setDestinationLocation ( const DtVector & destinationLocation )

virtual

Set/Get the destination location. Destination is stored in world (geocentric) coordinates.

virtual DtVector DtRailPathControllerPSR::destinationLocation ( ) const

virtual

Set/Get the destination location. Destination is stored in world (geocentric) coordinates.

virtual bool DtRailPathControllerPSR::destinationLocationSpecified ( ) const

virtual

Return if the destination location is specified. (Setting a destination location will specify it)

virtual void DtRailPathControllerPSR::unspecifyDestinationLocation ( )

virtual

Make the destination location unspecified.

virtual void DtRailPathControllerPSR::setDebugPath ( const DtUUID & )

virtual

Set/Get the generated debug path object if we are publishing one. Was: setPathName Deprecated. Only for backwards compatibility.

virtual const DtRwSimObjectReference& DtRailPathControllerPSR::debugPath ( ) const

virtual

Was: pathName All debug path functions are deprecated. Only for backwards compatibility.

virtual bool DtRailPathControllerPSR::debugPathSpecified ( ) const

virtual

Return if the path is specified. (Setting a path will specify it)

virtual void DtRailPathControllerPSR::unspecifyDebugPath ( )

virtual

Make the path unspecified.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwSimObjectReference DtRailPathControllerPSR::myDebugPath

protected

Parameter Name: destination-name
Parameter Description: Stores the name of the destination object if planning a path to a control object.
.

DtRwSimObjectReference DtRailPathControllerPSR::myDestination

protected

Parameter Name: destination-name
Parameter Description: Stores the name of the destination object if planning a path to a control object.
.

DtRwVector DtRailPathControllerPSR::myDestinationLocation

protected

Parameter Name: destination-location
Parameter Description: Stores the geocentric location of the destionation.
.

DtRwRailSegmentList DtRailPathControllerPSR::myPathList

protected

Parameter Name: path
Parameter Description: Stores the calculated rail path
.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/railPathControllerPSR.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation