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.

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

Inheritance diagram for DtOccupancyDirectorDescriptor:

Public Member Functions
	DtOccupancyDirectorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtOccupancyDirectorDescriptor (const DtOccupancyDirectorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual DtOccupancyDirectorDescriptor &	operator= (const DtOccupancyDirectorDescriptor &orig)
virtual	~DtOccupancyDirectorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	operator== (const DtOccupancyDirectorDescriptor &) const
virtual bool	operator!= (const DtOccupancyDirectorDescriptor &) const
virtual const DtRwTemplatedListPtr < DtLoadPoint, true > &	ingressPoints () const
virtual DtRwTemplatedListPtr < DtLoadPoint, true > &	ingressPoints ()
virtual const DtRwTemplatedListPtr < DtLoadPoint, true > &	egressPoints () const
virtual DtRwTemplatedListPtr < DtLoadPoint, true > &	egressPoints ()
virtual const DtRwTemplatedListPtr < DtSlotExclusion, true > &	slotExclusions () const
virtual DtRwTemplatedListPtr < DtSlotExclusion, true > &	slotExclusions ()
virtual bool	publishLoadPoints () const
virtual void	setPublishLoadPoints (bool)
virtual bool	flipDisembarkBodyX () const
virtual void	setFlipDisembarkBodyX (bool)
virtual bool	flipDisembarkBodyY () const
virtual void	setFlipDisembarkBodyY (bool)
virtual const DtRwList *	embarkationSlots () const
virtual DtRwList *	embarkationSlots ()
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual const DtString &	stateAndParameterDataPrefix () const
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)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
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)
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 const char *	readerWriterType () const
virtual const char *	xmlType () const
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	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	putData (DtEnvironmentSP, DtEnvValueSP value) 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	getData (const DtEnvironmentSP, const DtEnvValueSP, 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)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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
virtual bool	init ()
virtual DtRwList *	createSlotsList (const DtRwList *original=NULL)
virtual void	copySlotList (DtRwList *to, const DtRwList *from)
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwList *	mySlots
DtRwTemplatedListPtr < DtLoadPoint, true >	myIngressPoints
DtRwTemplatedListPtr < DtLoadPoint, true >	myEgressPoints
DtRwTemplatedListPtr < DtSlotExclusion, true >	mySlotExclusions
DtRwBoolean	myPublishLoadPoints
DtRwBoolean	myFlipDisembarkBodyX
DtRwBoolean	myFlipDisembarkBodyY
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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
	DtOccupancyDirectorDescriptor ()

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 Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
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

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.

virtual const DtRwTemplatedListPtr<DtLoadPoint,true>& DtOccupancyDirectorDescriptor::ingressPoints ( ) const

virtual

Accessor for myIngressPoints.

virtual DtRwTemplatedListPtr<DtLoadPoint,true>& DtOccupancyDirectorDescriptor::ingressPoints ( )

virtual

Accessor for myIngressPoints.

virtual const DtRwTemplatedListPtr<DtLoadPoint,true>& DtOccupancyDirectorDescriptor::egressPoints ( ) const

virtual

Accessor for myEgressPoints.

virtual DtRwTemplatedListPtr<DtLoadPoint,true>& DtOccupancyDirectorDescriptor::egressPoints ( )

virtual

Accessor for myEgressPoints.

virtual const DtRwTemplatedListPtr<DtSlotExclusion,true>& DtOccupancyDirectorDescriptor::slotExclusions ( ) const

virtual

Accessor for mySlotExclusions.

virtual DtRwTemplatedListPtr<DtSlotExclusion,true>& 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,true> 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,true> 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,true> 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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/occupancyDirectorDescriptor.h