DtLoadPoint Class Reference

DtLoadPoint; Readable/writeable object for describing position for entity loading/unloading. More...

Inheritance diagram for DtLoadPoint:

List of all members.

Public Member Functions
	DtLoadPoint (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLoadPoint (const DtLoadPoint &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtLoadPoint ()
DtLoadPoint &	operator= (const DtLoadPoint &orig)
	assignment
const DtRwTemplatedListPtr < DtRwVector > &	points () const
	Accessor for myPoints.
void	addPoint (const DtVector &)
	Add a point to myPoints.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual bool	operator== (const DtLoadPoint &) const
	Equivalence operator.
virtual bool	operator!= (const DtLoadPoint &) const
DtNLengthIntegerVector &	supportedSlots ()
	Accessor/mutator for mySlots.
const DtNLengthIntegerVector &	supportedSlots () const
	Accessor/mutator for mySlots.
void	setSupportedSlots (const DtNLengthIntegerVector &)
	Accessor/mutator for mySlots.
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtNLengthIntegerVector	mySlots
	Parameter Name: embarkation-slots Parameter Description: List of integer identifiers for positions that can be occupied by embarked entities.
DtRwTemplatedListPtr< DtRwVector >	myPoints
	Parameter Name: embarkation-load-points Parameter Description: List of position offsets relative to the entity being embarked upon.

---

Detailed Description

DtLoadPoint; Readable/writeable object for describing position for entity loading/unloading.

Instances of DtLoadPoint describe a point that an entity will move to when loading onto or unloading off of an entity.

---

Constructor & Destructor Documentation

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

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

virtual DtLoadPoint::~DtLoadPoint

(

)

[virtual]

---

Member Function Documentation

DtLoadPoint& DtLoadPoint::operator=

(

const DtLoadPoint &

orig

)

assignment

DtNLengthIntegerVector & DtLoadPoint::supportedSlots

(

)

[inline]

Accessor/mutator for mySlots.

References mySlots.

const DtNLengthIntegerVector & DtLoadPoint::supportedSlots

(

)

const [inline]

Accessor/mutator for mySlots.

References mySlots.

void DtLoadPoint::setSupportedSlots

(

const DtNLengthIntegerVector &

s

)

[inline]

Accessor/mutator for mySlots.

References mySlots.

const DtRwTemplatedListPtr< DtRwVector > & DtLoadPoint::points

(

)

const [inline]

Accessor for myPoints.

References myPoints.

void DtLoadPoint::addPoint

(

const DtVector &

v

)

[inline]

Add a point to myPoints.

References DtRwList::add(), and myPoints.

virtual const char* DtLoadPoint::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 bool DtLoadPoint::operator==

(

const DtLoadPoint &

)

const [virtual]

Equivalence operator.

virtual bool DtLoadPoint::operator!=

(

const DtLoadPoint &

)

const [virtual]

---

Member Data Documentation

DtNLengthIntegerVector DtLoadPoint::mySlots [protected]

Parameter Name: embarkation-slots
Parameter Description: List of integer identifiers for positions that can be occupied by embarked entities.

Parameter Default Value:

Referenced by setSupportedSlots(), and supportedSlots().

DtRwTemplatedListPtr<DtRwVector> DtLoadPoint::myPoints [protected]

Parameter Name: embarkation-load-points
Parameter Description: List of position offsets relative to the entity being embarked upon.

Parameter Default Value:

Referenced by addPoint(), and points().

---

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

• include/vrfobjparam/loadPoint.h