DtRailPathControllerPSR Class Reference

class DtRailPathControllerPSR: More...

Inheritance diagram for DtRailPathControllerPSR:

Public Member Functions
	DtRailPathControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRailPathControllerPSR (const DtRailPathControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtRailPathControllerPSR ()
	destructor
DtRailPathControllerPSR &	operator= (const DtRailPathControllerPSR &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.
virtual void	clear ()
virtual void	clearPath ()
virtual const DtRwTemplatedListPtr < DtRwRailSegment > &	pathList () const
virtual DtRwTemplatedListPtr < DtRwRailSegment > &	pathList ()
virtual void	addSegmentToPath (const DtRailSegment &seg, bool appendToEnd=true)
virtual void	addRailSegments (DtRailSegmentList *)
virtual void	setDestinationName (const DtString &destinationName)
virtual DtString	destinationName () const
virtual bool	destinationNameSpecified () const
	Return if the destination name is specified. (Setting a destination name will specify it)
virtual void	unspecifyDestinationName ()
	Make the destination name unspecified.
virtual void	setDestinationLocation (const DtVector &destinationLocation)
virtual DtVector	destinationLocation () const
virtual bool	destinationLocationSpecified () const
	Return if the destination location is specified. (Setting a destination location will specify it)
virtual void	unspecifyDestinationLocation ()
	Make the destination location unspecified.
virtual void	setPathName (const DtString &pathName)
virtual DtString	pathName () const
virtual bool	pathNameSpecified () const
	Return if the path name is specified. (Setting a path name will specify it)
virtual void	unspecifyPathName ()
	Make the path name unspecified.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *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 ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

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.
DtRwString	myPathName
	Parameter Name: destination-name Parameter Description: Stores the name of the destination object if planning a path to a control object.
DtRwString	myDestinationName
	Parameter Name: destination-name Parameter Description: Stores the name of the destination object if planning a path to a control object.
DtRwVector	myDestinationLocation
	Parameter Name: destination-location Parameter Description: Stores the geocentric location of the destionation.
DtRwTemplatedListPtr < DtRwRailSegment >	myPathList
	Parameter Name: path Parameter Description: Stores the calculated rail path .
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

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.

Constructor & Destructor Documentation

DtRailPathControllerPSR::DtRailPathControllerPSR	(	DtVrfObject *	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 DtRwTemplatedListPtr<DtRwRailSegment>& DtRailPathControllerPSR::pathList ( ) const

virtual

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

virtual DtRwTemplatedListPtr<DtRwRailSegment>& 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::setDestinationName ( const DtString &  destinationName )

virtual

Set/Get the name of the destination object.

virtual DtString DtRailPathControllerPSR::destinationName ( ) const

virtual

Set/Get the name of the destination object.

virtual bool DtRailPathControllerPSR::destinationNameSpecified ( ) const

virtual

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

virtual void DtRailPathControllerPSR::unspecifyDestinationName ( )

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::setPathName ( const DtString &  pathName )

virtual

Set/Get the name of the generated debug path object if we are publishing one.

virtual DtString DtRailPathControllerPSR::pathName ( ) const

virtual

Set/Get the name of the generated debug path object if we are publishing one.

virtual bool DtRailPathControllerPSR::pathNameSpecified ( ) const

virtual

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

virtual void DtRailPathControllerPSR::unspecifyPathName ( )

virtual

Make the path name unspecified.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwString DtRailPathControllerPSR::myPathName

protected

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

DtRwString DtRailPathControllerPSR::myDestinationName

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.

DtRwTemplatedListPtr<DtRwRailSegment> DtRailPathControllerPSR::myPathList

protected

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

---

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

• include/vrfobjcore/railPathControllerPSR.h