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:

[legend]

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 bool	flipDisembarkBodyX () const
	Accessor/mutator for myFlipDisembarkBodyX.
virtual void	setFlipDisembarkBodyX (bool)
	Accessor/mutator for myFlipDisembarkBodyX.

virtual bool	flipDisembarkBodyY () const
	Accessor/mutator for myFlipDisembarkBodyY.
virtual void	setFlipDisembarkBodyY (bool)
	Accessor/mutator for myFlipDisembarkBodyY.

virtual const DtRwList *	embarkationSlots () const
	Accessor for mySlots.
virtual DtRwList *	embarkationSlots ()
	Accessor for mySlots.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

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 Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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.
DtRwBoolean	myFlipDisembarkBodyX
	Parameter Name: flip-disembark-body-x Parameter Description: Whether or not to flip the sign on the disembark body X position for disembar all.
DtRwBoolean	myFlipDisembarkBodyY
	Parameter Name: flip-disembark-body-y Parameter Description: Whether or not to flip the sign on the disembark body Y position for disembark all.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtOccupancyDirectorDescriptor ()
	default constructor; not implemented

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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 bool DtOccupancyDirectorDescriptor::flipDisembarkBodyX ( ) const

virtual

Accessor/mutator for myFlipDisembarkBodyX.

virtual void DtOccupancyDirectorDescriptor::setFlipDisembarkBodyX ( bool )

virtual

Accessor/mutator for myFlipDisembarkBodyX.

virtual bool DtOccupancyDirectorDescriptor::flipDisembarkBodyY ( ) const

virtual

Accessor/mutator for myFlipDisembarkBodyY.

virtual void DtOccupancyDirectorDescriptor::setFlipDisembarkBodyY ( bool )

virtual

Accessor/mutator for myFlipDisembarkBodyY.

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

protectedvirtual

Creates templated list class.

Reimplemented from DtComponentDescriptor.

virtual DtRwList* DtOccupancyDirectorDescriptor::createSlotsList ( const DtRwList * original = NULL )

protectedvirtual

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
	)

protectedvirtual

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

DtRwBoolean DtOccupancyDirectorDescriptor::myFlipDisembarkBodyX

protected

Parameter Name: flip-disembark-body-x
Parameter Description: Whether or not to flip the sign on the disembark body X position for disembar all.

Default is not to, and, the default value is - move in body X position.
Parameter Default Value: false

DtRwBoolean DtOccupancyDirectorDescriptor::myFlipDisembarkBodyY

protected

Parameter Name: flip-disembark-body-y
Parameter Description: Whether or not to flip the sign on the disembark body Y position for disembark all.

Default is not to, and, the default value is + move in body Y position.
Parameter Default Value: false

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/occupancyDirectorDesc.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation