DtVrfEmbarkationPSR Class Reference

class DtVrfEmbarkationPSR: More...

Inheritance diagram for DtVrfEmbarkationPSR:

List of all members.

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 (int)
	Aggregates only.
virtual int	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.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
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.
DtRwInt	myCurrentSubordinateTask

---

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]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::getEmbarkationInformation	(	DtString &	parent,
		bool &	useEmbarkationOverride,
		DtVector &	embarkationOverridePosition
	)		[virtual]

Set/get embarkation information.

virtual const DtString& DtVrfEmbarkationPSR::embarkationParent

(

)

const [virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::embarkationLocationOverride

(

)

const [virtual]

Set/get embarkation information.

virtual const DtVector& DtVrfEmbarkationPSR::embarkationLocationOverridePosition

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setControlPointName

(

const DtString &

)

[virtual]

Set/get embarkation information.

virtual const DtString& DtVrfEmbarkationPSR::controlPointName

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setEmbarkedAppearance

(

int

)

[virtual]

Set/get embarkation information.

virtual int DtVrfEmbarkationPSR::embarkedAppearance

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setPublishLoadPoints

(

bool

)

[virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::publishLoadPoints

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setOnGroundBeforeDisembark

(

bool

)

[virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::onGroundBeforeDisembark

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setEmbarkedOrientation

(

const DtTaitBryan &

)

[virtual]

Set/get embarkation information.

virtual const DtTaitBryan& DtVrfEmbarkationPSR::embarkedOrientation

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::clearEmbarkationInformation

(

)

[virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setJumpToLocation

(

bool

b

)

[virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::jumpToLocation

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setTurnToHeading

(

bool

b

)

[virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::turnToHeading

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setExitPosition

(

const DtVector &

)

[virtual]

Set/get embarkation information.

virtual const DtVector& DtVrfEmbarkationPSR::exitPosition

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::setCurrentSubordinateTask

(

int

)

[virtual]

Aggregates only.

virtual int DtVrfEmbarkationPSR::currentSubordinateTask

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::addTaskedSubordinate

(

const DtString &

name

)

[virtual]

Set/get embarkation information.

virtual bool DtVrfEmbarkationPSR::removeTaskedSubordinate

(

const DtString &

name

)

[virtual]

Set/get embarkation information.

virtual const DtRwTemplatedListPtr<DtRwString>& DtVrfEmbarkationPSR::taskedSubordinates

(

)

const [virtual]

Set/get embarkation information.

virtual void DtVrfEmbarkationPSR::clearTaskedSubordinates

(

)

[virtual]

Set/get embarkation information.

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

Returns a newly created instance of this class.

---

Member Data Documentation

DtRwInt DtVrfEmbarkationPSR::myEmbarkationState [protected]

DtRwString DtVrfEmbarkationPSR::myControlPointName [protected]

DtRwString DtVrfEmbarkationPSR::myEmbarkationParent [protected]

DtRwBoolean DtVrfEmbarkationPSR::myEmbarkationLocationOverride [protected]

DtRwVector DtVrfEmbarkationPSR::myEmbarkationLocationOverridePosition [protected]

DtRwVector DtVrfEmbarkationPSR::myExitPosition [protected]

DtRwInt DtVrfEmbarkationPSR::myEmbarkedAppearance [protected]

DtRwTaitBryan DtVrfEmbarkationPSR::myEmbarkedOrientation [protected]

DtRwBoolean DtVrfEmbarkationPSR::myPublishLoadPoints [protected]

DtRwBoolean DtVrfEmbarkationPSR::myOnGroundBeforeDisembark [protected]

DtRwBoolean DtVrfEmbarkationPSR::myJumpToLocation [protected]

DtRwBoolean DtVrfEmbarkationPSR::myTurnToHeading [protected]

DtRwTemplatedListPtr<DtRwString> DtVrfEmbarkationPSR::myTaskedSubordinates [protected]

Aggregates only.

DtRwInt DtVrfEmbarkationPSR::myCurrentSubordinateTask [protected]

---

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

• include/vrfobjcore/embarkationPSR.h