DtEmbarkationSlotEntry Class Reference

DtEmbarkationSlotEntry. More...

Inheritance diagram for DtEmbarkationSlotEntry:

List of all members.

Public Member Functions
	DtEmbarkationSlotEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	reader-writer constructor
virtual	~DtEmbarkationSlotEntry ()
	destructor
	DtEmbarkationSlotEntry (const DtString &name, const DtEmbarkationSlotEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtEmbarkationSlotEntry (const DtEmbarkationSlotEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtEmbarkationSlotEntry &	operator= (const DtEmbarkationSlotEntry &orig)
	assignment operator
virtual DtEmbarkationSlotEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtEmbarkationSlotEntry *	clone () const
virtual bool	operator== (const DtEmbarkationSlotEntry &) const
	Equality operators.
virtual bool	operator!= (const DtEmbarkationSlotEntry &) const
const DtRangedObjectType &	object () const
	Accessor/mutator for myObject.
void	setObject (const DtRangedObjectType &)
	Accessor/mutator for myObject.
const DtVector &	position () const
	Accessor/mutator for myPosition.
void	setPosition (const DtVector &)
	Accessor/mutator for myPosition.
const DtRwTaitBryan	orientation () const
	Accessor/mutator for myOrientation.
void	setOrientation (const DtTaitBryan &)
	Accessor/mutator for myOrientation.
int	numberOfEntities () const
	Accessor/mutator for myNumberOfEntities.
void	setNumberOfEntities (int)
	Accessor/mutator for myNumberOfEntities.
const DtAppearance &	appearance () const
	Accessor/mutator for myAppearance.
void	setAppearance (const DtAppearance &)
	Accessor/mutator for myAppearance.
void	setAppearance (int)
	Accessor/mutator for myAppearance.
bool	jumpToLocation () const
	Accessor/mutator for myJumpToLocation.
void	setJumpToLocation (bool)
	Accessor/mutator for myJumpToLocation.
bool	turnToHeading () const
	Accessor/mutator for myTurnToHeading.
void	setTurnToHeading (bool)
	Accessor/mutator for myTurnToHeading.
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwRangedObjectType	myObject
	Parameter Name: embarkable-object Parameter Description: Parameter Default Value: .
DtRwVector	myPosition
	Parameter Name: embarked-position Parameter Description: Parameter Default Value: .
DtRwTaitBryan	myOrientation
	Parameter Name: embarked-orientation Parameter Description: Parameter Default Value: .
DtRwAppearance	myAppearance
	Parameter Name: embarked-appearance Parameter Description: Parameter Default Value: .
DtRwInt	myNumberOfEntities
	Parameter Name: number-of-entities Parameter Description: Number of entities that can occupy this slot -1 means any amount Parameter Default Value: 1 .
DtRwBoolean	myJumpToLocation
	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 .
DtRwBoolean	myTurnToHeading
	Parameter Name: turn-to-heading Parameter Description: Turn to correct heading on start of ingress/egress route or from ingress point to slot or slot to egress point Parameter Default Value: true .
Private Member Functions
	DtEmbarkationSlotEntry ()
	default constructor

---

Detailed Description

DtEmbarkationSlotEntry.

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

---

Constructor & Destructor Documentation

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

reader-writer constructor

virtual DtEmbarkationSlotEntry::~DtEmbarkationSlotEntry

(

)

[virtual]

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 DtRangedObjectType & DtEmbarkationSlotEntry::object

(

)

const [inline]

Accessor/mutator for myObject.

References myObject.

void DtEmbarkationSlotEntry::setObject

(

const DtRangedObjectType &

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.

virtual const char* DtEmbarkationSlotEntry::readerWriterType

(

)

const [virtual]

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]

---

Member Data Documentation

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

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 ingress/egress route
or from ingress point to slot or slot to egress point
Parameter Default Value: true
.

Referenced by setTurnToHeading(), and turnToHeading().

---

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

• include/vrfobjparam/embarkationSlotEntry.h