Inheritance diagram for DtVrfEmbarkationPSR:

Public Types

enum DtEmbarkationControllerState {
DtIdle = 0, DtMoveToEgress = 5, DtMovingToEgress, DtDisembark,
DtMoveToIngress, DtMovingToIngress, DtMoveToEmbarkationPoint, DtMovingToEmbarkationPoint,
DtAtEmbarkationPoint, DtWaitingToStop, DtStoppedAtEmbarkedPoint, DtWaitingForEmbarkationInformation,
DtWaitingForDisembarkationInformation, DtMoveToFinalDestination, DtMovingToFinalDestination, DtCompletingTask
}

Public Member Functions
	DtVrfEmbarkationPSR (DtVrfObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	constructor
	DtVrfEmbarkationPSR (const DtVrfEmbarkationPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtVrfEmbarkationPSR ()
	destructor
DtVrfEmbarkationPSR &	operator= (const DtVrfEmbarkationPSR &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	setEmbarkationState (DtEmbarkationControllerState state)
	Set/get current state.
virtual DtEmbarkationControllerState	embarkationState () const
	Set/get current state.

virtual void	setEmbarkationInformation (const DtString &parent, bool useEmbarkationOverride=false, const DtVector &embarkationOverridePosition=DtVector::zero())
	Set/get embarkation information.
virtual void	getEmbarkationInformation (DtString &parent, bool &useEmbarkationOverride, DtVector &embarkationOverridePosition)
	Set/get embarkation information.
virtual const DtString &	embarkationParent () const
	Set/get embarkation information.
virtual bool	embarkationLocationOverride () const
	Set/get embarkation information.
virtual const DtVector &	embarkationLocationOverridePosition () const
	Set/get embarkation information.
virtual void	setControlPointName (const DtString &)
	Set/get embarkation information.
virtual const DtString &	controlPointName () const
	Set/get embarkation information.
virtual void	setEmbarkedAppearance (int)
	Set/get embarkation information.
virtual int	embarkedAppearance () const
	Set/get embarkation information.
virtual void	setPublishLoadPoints (bool)
	Set/get embarkation information.
virtual bool	publishLoadPoints () const
	Set/get embarkation information.
virtual void	setOnGroundBeforeDisembark (bool)
	Set/get embarkation information.
virtual bool	onGroundBeforeDisembark () const
	Set/get embarkation information.
virtual void	setEmbarkedOrientation (const DtTaitBryan &)
	Set/get embarkation information.
virtual const DtTaitBryan &	embarkedOrientation () const
	Set/get embarkation information.
virtual void	clearEmbarkationInformation ()
	Set/get embarkation information.
virtual void	setJumpToLocation (bool b)
	Set/get embarkation information.
virtual bool	jumpToLocation () const
	Set/get embarkation information.
virtual void	setTurnToHeading (bool b)
	Set/get embarkation information.
virtual bool	turnToHeading () const
	Set/get embarkation information.
virtual void	setExitPosition (const DtVector &)
	Set/get embarkation information.
virtual const DtVector &	exitPosition () const
	Set/get embarkation information.
virtual void	setCurrentSubordinateTask (const DtSimTaskMessageType &)
	Aggregates only.
virtual DtSimTaskMessageType	currentSubordinateTask () const
	Set/get embarkation information.
virtual void	addTaskedSubordinate (const DtString &name)
	Set/get embarkation information.
virtual bool	removeTaskedSubordinate (const DtString &name)
	Set/get embarkation information.
virtual const DtRwTemplatedListPtr < DtRwString > &	taskedSubordinates () const
	Set/get embarkation information.
virtual void	clearTaskedSubordinates ()
	Set/get embarkation information.
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
DtRwInt	myEmbarkationState
DtRwString	myControlPointName
DtRwString	myEmbarkationParent
DtRwBoolean	myEmbarkationLocationOverride
DtRwVector	myEmbarkationLocationOverridePosition
DtRwVector	myExitPosition
DtRwInt	myEmbarkedAppearance
DtRwTaitBryan	myEmbarkedOrientation
DtRwBoolean	myPublishLoadPoints
DtRwBoolean	myOnGroundBeforeDisembark
DtRwBoolean	myJumpToLocation
DtRwBoolean	myTurnToHeading
DtRwTemplatedListPtr< DtRwString >	myTaskedSubordinates
	Aggregates only.
DtRwString	myCurrentSubordinateTask
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
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtVrfEmbarkationPSR:

Instances of DtVrfEmbarkationPSR are used to hold the shared/checkpointable data for an embarkation system.

Member Enumeration Documentation

enum DtVrfEmbarkationPSR::DtEmbarkationControllerState

Enumerator:

DtIdle
DtMoveToEgress
DtMovingToEgress
DtDisembark
DtMoveToIngress
DtMovingToIngress
DtMoveToEmbarkationPoint
DtMovingToEmbarkationPoint
DtAtEmbarkationPoint
DtWaitingToStop
DtStoppedAtEmbarkedPoint
DtWaitingForEmbarkationInformation
DtWaitingForDisembarkationInformation
DtMoveToFinalDestination
DtMovingToFinalDestination
DtCompletingTask

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtVrfEmbarkationPSR::~DtVrfEmbarkationPSR ( )

virtual

destructor

Member Function Documentation

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

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtVrfEmbarkationPSR::type ( ) const

virtual

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

(DtVrfEmbarkationProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtVrfEmbarkationPSR::setEmbarkationState ( DtEmbarkationControllerState state )

virtual

Set/get current state.

virtual DtEmbarkationControllerState DtVrfEmbarkationPSR::embarkationState ( ) const

virtual

Set/get current state.

virtual void DtVrfEmbarkationPSR::setEmbarkationInformation	(	const DtString &	parent,
		bool	useEmbarkationOverride = `false`,
		const DtVector &	embarkationOverridePosition = `DtVector::zero()`
	)

virtual