Instances of DtEmbarkationSlotEntry are used by the DtOccupancyDirectoryController to determine who can embark on this object and what slots are available.

Inheritance diagram for DtEmbarkationSlotEntry:

[legend]

Public Member Functions
	DtEmbarkationSlotEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtEmbarkationSlotEntry () override

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

	DtEmbarkationSlotEntry (const DtEmbarkationSlotEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtEmbarkationSlotEntry &	operator= (const DtEmbarkationSlotEntry &orig)

virtual DtEmbarkationSlotEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual const char *	readerWriterType () const override

virtual DtEmbarkationSlotEntry *	clone () const

virtual bool	operator== (const DtEmbarkationSlotEntry &) const

virtual bool	operator!= (const DtEmbarkationSlotEntry &) const


const DtRangedEntityType &	object () const

void	setObject (const DtRangedEntityType &)


const DtVector &	position () const

void	setPosition (const DtVector &)


const DtRwTaitBryan	orientation () const

void	setOrientation (const DtTaitBryan &)


int	numberOfEntities () const

void	setNumberOfEntities (int)


const DtAppearance &	appearance () const

void	setAppearance (const DtAppearance &)

void	setAppearance (int)


bool	jumpToLocation () const

void	setJumpToLocation (bool)


bool	turnToHeading () const

void	setTurnToHeading (bool)


bool	orientOnIngress () const

void	setOrientOnIngress (bool)


bool	invisibleWhenEmbarked () const

void	setInvisibleWhenEmbarked (bool)


const DtString &	slotName () const

void	setSlotName (const DtString &)


const DtString &	slotType () const

void	setSlotType (const DtString &)


const DtString &	stationName () const

void	setStationName (const DtString &)


const DtString &	ingressTechnique () const

void	setIngressTechnique (const DtString &)


const DtString &	egressTechnique () const

void	setEgressTechnique (const DtString &)


const DtString &	animation () const

void	setAnimation (const DtString &)

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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, 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)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwRangedEntityType	myObject

DtRwVector	myPosition

DtRwTaitBryan	myOrientation

DtRwAppearance	myAppearance

DtRwString	myAnimation

DtRwInt	myNumberOfEntities

DtRwBoolean	myJumpToLocation

DtRwBoolean	myTurnToHeading

DtRwBoolean	myOrientOnIngress

DtRwBoolean	myInvisibleWhenEmbarked

DtRwString	mySlotName

DtRwString	mySlotType

DtRwString	myStationName

DtRwString	myIngressTechnique

DtRwString	myEgressTechnique

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

Private Member Functions
	DtEmbarkationSlotEntry ()

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual const char *	xmlType () const override

static const char *	theXmlType ()

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

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 Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

DtEmbarkationSlotEntry::DtEmbarkationSlotEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

reader-writer constructor

virtual DtEmbarkationSlotEntry::~DtEmbarkationSlotEntry ( )

overridevirtual

destructor

DtEmbarkationSlotEntry::DtEmbarkationSlotEntry	(	const DtString &	name,
		const DtEmbarkationSlotEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

DtEmbarkationSlotEntry::DtEmbarkationSlotEntry	(	const DtEmbarkationSlotEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

DtEmbarkationSlotEntry::DtEmbarkationSlotEntry ( )

private

default constructor

Member Function Documentation

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

assignment operator

virtual DtEmbarkationSlotEntry* DtEmbarkationSlotEntry::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

const DtRangedEntityType & DtEmbarkationSlotEntry::object ( ) const

inline

Accessor/mutator for myObject.

References myObject.

void DtEmbarkationSlotEntry::setObject ( const DtRangedEntityType & o )

inline

Accessor/mutator for myObject.

References myObject.

const DtVector & DtEmbarkationSlotEntry::position ( ) const

inline

Accessor/mutator for myPosition.

References myPosition.

void DtEmbarkationSlotEntry::setPosition ( const DtVector & v )

inline

Accessor/mutator for myPosition.

References myPosition.

const DtRwTaitBryan DtEmbarkationSlotEntry::orientation ( ) const

inline

Accessor/mutator for myOrientation.

References myOrientation.

void DtEmbarkationSlotEntry::setOrientation ( const DtTaitBryan & o )

inline

Accessor/mutator for myOrientation.

References myOrientation.

int DtEmbarkationSlotEntry::numberOfEntities ( ) const

inline

Accessor/mutator for myNumberOfEntities.

References myNumberOfEntities.

void DtEmbarkationSlotEntry::setNumberOfEntities ( int a )

inline

Accessor/mutator for myNumberOfEntities.

References myNumberOfEntities.

const DtAppearance & DtEmbarkationSlotEntry::appearance ( ) const

inline

Accessor/mutator for myAppearance.

References myAppearance.

void DtEmbarkationSlotEntry::setAppearance ( const DtAppearance & a )

inline

Accessor/mutator for myAppearance.

References myAppearance.

void DtEmbarkationSlotEntry::setAppearance ( int a )

inline

Accessor/mutator for myAppearance.

References myAppearance.

bool DtEmbarkationSlotEntry::jumpToLocation ( ) const

inline

Accessor/mutator for myJumpToLocation.

References myJumpToLocation.

void DtEmbarkationSlotEntry::setJumpToLocation ( bool b )

inline

Accessor/mutator for myJumpToLocation.

References myJumpToLocation.

bool DtEmbarkationSlotEntry::turnToHeading ( ) const

inline

Accessor/mutator for myTurnToHeading.

References myTurnToHeading.

void DtEmbarkationSlotEntry::setTurnToHeading ( bool b )

inline

Accessor/mutator for myTurnToHeading.

References myTurnToHeading.

bool DtEmbarkationSlotEntry::orientOnIngress ( ) const

inline

Accessor/mutator for myOrientOnIngress.

References myOrientOnIngress.

void DtEmbarkationSlotEntry::setOrientOnIngress ( bool b )

inline

Accessor/mutator for myOrientOnIngress.

References myOrientOnIngress.

bool DtEmbarkationSlotEntry::invisibleWhenEmbarked ( ) const

inline

Accessor/mutator for myInvisibleWhenEmbarked.

References myInvisibleWhenEmbarked.

void DtEmbarkationSlotEntry::setInvisibleWhenEmbarked ( bool b )

inline

Accessor/mutator for myInvisibleWhenEmbarked.

References myInvisibleWhenEmbarked.

const DtString & DtEmbarkationSlotEntry::slotName ( ) const

inline

Accessor/mutator for mySlotName.

References mySlotName.

void DtEmbarkationSlotEntry::setSlotName ( const DtString & s )

inline

Accessor/mutator for mySlotName.

References mySlotName.

const DtString & DtEmbarkationSlotEntry::slotType ( ) const

inline

Accessor/mutator for mySlotType.

References mySlotType.

void DtEmbarkationSlotEntry::setSlotType ( const DtString & s )

inline

Accessor/mutator for mySlotType.

References mySlotType.

const DtString & DtEmbarkationSlotEntry::stationName ( ) const

inline

Accessor/mutator for myStationName.

References myStationName.

void DtEmbarkationSlotEntry::setStationName ( const DtString & s )

inline

Accessor/mutator for myStationName.

References myStationName.

const DtString & DtEmbarkationSlotEntry::ingressTechnique ( ) const

inline

Accessor/mutator for myIngressTechnique.

References myIngressTechnique.

void DtEmbarkationSlotEntry::setIngressTechnique ( const DtString & s )

inline

Accessor/mutator for myIngressTechnique.

References myIngressTechnique.

const DtString & DtEmbarkationSlotEntry::egressTechnique ( ) const

inline

Accessor/mutator for myEgressTechnique.

References myEgressTechnique.

void DtEmbarkationSlotEntry::setEgressTechnique ( const DtString & s )

inline

Accessor/mutator for myEgressTechnique.

References myEgressTechnique.

const DtString & DtEmbarkationSlotEntry::animation ( ) const

inline

Accessor/mutator for myAnimation.

References myAnimation.

void DtEmbarkationSlotEntry::setAnimation ( const DtString & s )

inline

Accessor/mutator for myAnimation.

References myAnimation.

virtual const char* DtEmbarkationSlotEntry::readerWriterType ( ) const

overridevirtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

virtual DtEmbarkationSlotEntry* DtEmbarkationSlotEntry::clone ( ) const

virtual

virtual bool DtEmbarkationSlotEntry::operator== ( const DtEmbarkationSlotEntry & ) const

virtual

Equality operators.

virtual bool DtEmbarkationSlotEntry::operator!= ( const DtEmbarkationSlotEntry & ) const

virtual

virtual void DtEmbarkationSlotEntry::putData	(	DtEnvironmentSP	,
		DtEnvValueSP	parent
	)		const

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtEmbarkationSlotEntry::getData	(	const DtEnvironmentSP	,
		const DtEnvValueSP	value,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

static const char* DtEmbarkationSlotEntry::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtEmbarkationSlotEntry::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwRangedEntityType DtEmbarkationSlotEntry::myObject

protected

Parameter Name: embarkable-object
Parameter Description:
Parameter Default Value:
.

Referenced by object(), and setObject().

DtRwVector DtEmbarkationSlotEntry::myPosition

protected

Parameter Name: embarked-position
Parameter Description:
Parameter Default Value:
.

Referenced by position(), and setPosition().

DtRwTaitBryan DtEmbarkationSlotEntry::myOrientation

protected

Parameter Name: embarked-orientation
Parameter Description:
Parameter Default Value:
.

Referenced by orientation(), and setOrientation().

DtRwAppearance DtEmbarkationSlotEntry::myAppearance

protected

Parameter Name: embarked-appearance
Parameter Description:
Parameter Default Value:
.

Referenced by appearance(), and setAppearance().

DtRwString DtEmbarkationSlotEntry::myAnimation

protected

Parameter Name: animation
Parameter Description: The DI-Guy animation to use when embarked. Only supported on DI-Guy objects.
Parameter Default Value:
.

Referenced by animation(), and setAnimation().

DtRwInt DtEmbarkationSlotEntry::myNumberOfEntities

protected

Parameter Name: number-of-entities
Parameter Description: Number of entities that can occupy this slot
-1 means any amount
Parameter Default Value: 1
.

Referenced by numberOfEntities(), and setNumberOfEntities().

DtRwBoolean DtEmbarkationSlotEntry::myJumpToLocation

protected

Parameter Name: jump-to-location
Parameter Description: Jump to this location from the end of the
ingress or beginning of egress
Parameter Default Value: true
.

Referenced by jumpToLocation(), and setJumpToLocation().

DtRwBoolean DtEmbarkationSlotEntry::myTurnToHeading

protected

Parameter Name: turn-to-heading
Parameter Description: Turn to correct heading on start of egress route
or from ingress point to slot or slot to egress point
Parameter Default Value: true
.

Referenced by setTurnToHeading(), and turnToHeading().

DtRwBoolean DtEmbarkationSlotEntry::myOrientOnIngress

protected

Parameter Name: orient-on-ingress
Parameter Description: For the ingress route only, snap to an orientation that will point the entity along the direction of ingress movement
Parameter Default Value: false
.

Referenced by orientOnIngress(), and setOrientOnIngress().

DtRwBoolean DtEmbarkationSlotEntry::myInvisibleWhenEmbarked

protected

Parameter Name: invisible-when-embarked
Parameter Description: Whether or not, when embarked, this entity will become invisible to the back-end and front-end
Parameter Default Value: false
.

Referenced by invisibleWhenEmbarked(), and setInvisibleWhenEmbarked().

DtRwString DtEmbarkationSlotEntry::mySlotName

protected

Parameter Name: slot-name
Parameter Description: Free form string that will give the name of this slot. Should be unique (e.g. Left Front Driver Seat)
Parameter Default Value:
.

Referenced by setSlotName(), and slotName().

DtRwString DtEmbarkationSlotEntry::mySlotType

protected

Parameter Name: slot-type
Parameter Description: Free for string that defines the type of slot. This does not need to be unique (e.g. Passenger)
Parameter Default Value:
.

Referenced by setSlotType(), and slotType().

DtRwString DtEmbarkationSlotEntry::myStationName

protected

Parameter Name: station-name
Parameter Description: DIS station name for this slot
Parameter Default Value: 16 (On Station xyz)
.

Referenced by setStationName(), and stationName().

DtRwString DtEmbarkationSlotEntry::myIngressTechnique

protected

Parameter Name: ingress-technique
Parameter Description: When getting into a slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot
Parameter Default Value:
.

Referenced by ingressTechnique(), and setIngressTechnique().

DtRwString DtEmbarkationSlotEntry::myEgressTechnique

protected

Parameter Name: egress-technique
Parameter Description: When getting out of slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot
Parameter Default Value:
.

Referenced by egressTechnique(), and setEgressTechnique().

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/embarkationSlotEntry.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation