DtOccupancyDirectorDescriptor Class Reference

Class DtOccupancyDirectorDescriptor is a DtComponentDescriptor that has parameters that configure the host object to allow it to tell what kinds of objects can be embarked on it and where they go. More...

Inheritance diagram for DtOccupancyDirectorDescriptor:

List of all members.

Public Member Functions
	DtOccupancyDirectorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtOccupancyDirectorDescriptor (const DtOccupancyDirectorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual DtOccupancyDirectorDescriptor &	operator= (const DtOccupancyDirectorDescriptor &orig)
	assignment
virtual	~DtOccupancyDirectorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	operator== (const DtOccupancyDirectorDescriptor &) const
	Equality operators.
virtual bool	operator!= (const DtOccupancyDirectorDescriptor &) const
virtual const DtRwTemplatedListPtr < DtLoadPoint > &	ingressPoints () const
	Accessor for myIngressPoints.
virtual DtRwTemplatedListPtr < DtLoadPoint > &	ingressPoints ()
	Accessor for myIngressPoints.
virtual const DtRwTemplatedListPtr < DtLoadPoint > &	egressPoints () const
	Accessor for myEgressPoints.
virtual DtRwTemplatedListPtr < DtLoadPoint > &	egressPoints ()
	Accessor for myEgressPoints.
virtual const DtRwTemplatedListPtr < DtSlotExclusion > &	slotExclusions () const
	Accessor for mySlotExclusions.
virtual DtRwTemplatedListPtr < DtSlotExclusion > &	slotExclusions ()
	Accessor for mySlotExclusions.
virtual bool	publishLoadPoints () const
	Accessor/mutator for myPublishLoadPoints.
virtual void	setPublishLoadPoints (bool)
	Accessor/mutator for myPublishLoadPoints.
virtual const DtRwList *	embarkationSlots () const
	Accessor for mySlots.
virtual DtRwList *	embarkationSlots ()
	Accessor for mySlots.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual bool	init ()
	Creates templated list class.
virtual DtRwList *	createSlotsList (const DtRwList *original=NULL)
	Called from init() and clone() member functions.
virtual void	copySlotList (DtRwList *to, const DtRwList *from)
	Note will need to cast to appropriate list type for copying (or, do your own custom copy from from list to to list)
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwList *	mySlots
	Parameter Name: embarkation-slots Parameter Description: List of DtEmbarkationSlotEntry objects, representing locations reserved for other entities at which to embark.
DtRwTemplatedListPtr< DtLoadPoint >	myIngressPoints
	Parameter Name: ingress-points Parameter Description: List of DtLoadPoint objects defining a location or path (sequence of locations) that a entity should move to/move along when embarking on another entity.
DtRwTemplatedListPtr< DtLoadPoint >	myEgressPoints
	Parameter Name: egress-points Parameter Description: List of DtLoadPoint objects defining a location or path (sequence of locations) that a entity should move to/move along when disembarking from another entity.
DtRwTemplatedListPtr < DtSlotExclusion >	mySlotExclusions
	Parameter Name: slot-exclusions Parameter Description: Lists of DtSlotExclusion objects that define those slots that become unavailable for embarkation, given certain slot(s) are occupied.
DtRwBoolean	myPublishLoadPoints
	Parameter Name: publish-load-points Parameter Description: Flag indicating whether or not to publish the load points (ingress/egress) of potentially embarking entities.
Private Member Functions
	DtOccupancyDirectorDescriptor ()
	default constructor; not implemented

---

Detailed Description

Class DtOccupancyDirectorDescriptor is a DtComponentDescriptor that has parameters that configure the host object to allow it to tell what kinds of objects can be embarked on it and where they go.

If you wish to extend the type of information contained int the slot, create your new subclass of DtEmbarkationSlotEntry and then create a list in the "createSlotList()" method for that type

---

Constructor & Destructor Documentation

DtOccupancyDirectorDescriptor::DtOccupancyDirectorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtOccupancyDirectorDescriptor::DtOccupancyDirectorDescriptor	(	const DtOccupancyDirectorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtOccupancyDirectorDescriptor::~DtOccupancyDirectorDescriptor

(

)

[virtual]

destructor

DtOccupancyDirectorDescriptor::DtOccupancyDirectorDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

virtual DtOccupancyDirectorDescriptor& DtOccupancyDirectorDescriptor::operator=

(

const DtOccupancyDirectorDescriptor &

orig

)

[virtual]

assignment

virtual DtString DtOccupancyDirectorDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtOccupancyDirectorDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtOccupancyDirectorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtOccupancyDirectorDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

virtual const DtRwTemplatedListPtr<DtLoadPoint>& DtOccupancyDirectorDescriptor::ingressPoints

(

)

const [virtual]

Accessor for myIngressPoints.

virtual DtRwTemplatedListPtr<DtLoadPoint>& DtOccupancyDirectorDescriptor::ingressPoints

(

)

[virtual]

Accessor for myIngressPoints.

virtual const DtRwTemplatedListPtr<DtLoadPoint>& DtOccupancyDirectorDescriptor::egressPoints

(

)

const [virtual]

Accessor for myEgressPoints.

virtual DtRwTemplatedListPtr<DtLoadPoint>& DtOccupancyDirectorDescriptor::egressPoints

(

)

[virtual]

Accessor for myEgressPoints.

virtual const DtRwTemplatedListPtr<DtSlotExclusion>& DtOccupancyDirectorDescriptor::slotExclusions

(

)

const [virtual]

Accessor for mySlotExclusions.

virtual DtRwTemplatedListPtr<DtSlotExclusion>& DtOccupancyDirectorDescriptor::slotExclusions

(

)

[virtual]

Accessor for mySlotExclusions.

virtual bool DtOccupancyDirectorDescriptor::publishLoadPoints

(

)

const [virtual]

Accessor/mutator for myPublishLoadPoints.

virtual void DtOccupancyDirectorDescriptor::setPublishLoadPoints

(

bool

)

[virtual]

Accessor/mutator for myPublishLoadPoints.

virtual const DtRwList* DtOccupancyDirectorDescriptor::embarkationSlots

(

)

const [virtual]

Accessor for mySlots.

virtual DtRwList* DtOccupancyDirectorDescriptor::embarkationSlots

(

)

[virtual]

Accessor for mySlots.

virtual bool DtOccupancyDirectorDescriptor::operator==

(

const DtOccupancyDirectorDescriptor &

)

const [virtual]

Equality operators.

virtual bool DtOccupancyDirectorDescriptor::operator!=

(

const DtOccupancyDirectorDescriptor &

)

const [virtual]

virtual bool DtOccupancyDirectorDescriptor::init

(

)

[protected, virtual]

Creates templated list class.

Reimplemented from DtComponentDescriptor.

virtual DtRwList* DtOccupancyDirectorDescriptor::createSlotsList

(

const DtRwList *

original = NULL

)

[protected, virtual]

Called from init() and clone() member functions.

If you implement your own subclass, make sure to delete the existing mySlots pointer before calling this method in your copy constructor to create the new entry. The list must be capable of cloning itself (and all items) with operator=, and able to delete all it's member in the destructor.

virtual void DtOccupancyDirectorDescriptor::copySlotList	(	DtRwList *	to,
		const DtRwList *	from
	)		[protected, virtual]

Note will need to cast to appropriate list type for copying (or, do your own custom copy from from list to to list)

---

Member Data Documentation

DtRwList* DtOccupancyDirectorDescriptor::mySlots [protected]

Parameter Name: embarkation-slots
Parameter Description: List of DtEmbarkationSlotEntry objects, representing locations reserved for other entities at which to embark.

DtRwTemplatedListPtr<DtLoadPoint> DtOccupancyDirectorDescriptor::myIngressPoints [protected]

Parameter Name: ingress-points
Parameter Description: List of DtLoadPoint objects defining a location or path (sequence of locations) that a entity should move to/move along when embarking on another entity.

DtRwTemplatedListPtr<DtLoadPoint> DtOccupancyDirectorDescriptor::myEgressPoints [protected]

Parameter Name: egress-points
Parameter Description: List of DtLoadPoint objects defining a location or path (sequence of locations) that a entity should move to/move along when disembarking from another entity.

DtRwTemplatedListPtr<DtSlotExclusion> DtOccupancyDirectorDescriptor::mySlotExclusions [protected]

Parameter Name: slot-exclusions
Parameter Description: Lists of DtSlotExclusion objects that define those slots that become unavailable for embarkation, given certain slot(s) are occupied.

DtRwBoolean DtOccupancyDirectorDescriptor::myPublishLoadPoints [protected]

Parameter Name: publish-load-points
Parameter Description: Flag indicating whether or not to publish the load points (ingress/egress) of potentially embarking entities.

Parameter Default Value: false

---

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

• include/vrfobjparam/occupancyDirectorDesc.h