DtEmbarkationSlotManager Class Reference

Inheritance diagram for DtEmbarkationSlotManager:

Public Member Functions
	DtEmbarkationSlotManager (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtEmbarkationSlotManager (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtEmbarkationSlotManager (const DtString &name, const DtEmbarkationSlotManager &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtEmbarkationSlotManager (const DtSymbolString &name, const DtEmbarkationSlotManager &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtEmbarkationSlotManager ()
virtual void	addSlot (int iSlot, const DtEmbarkationSlotEntry *)
virtual DtEmbarkationSlotInformation	slotFor (const DtVrfObject *embarkingObject, const DtVrfObject *hostObject) const
virtual DtEmbarkationSlotInformation	entityEmbarkationSlotInformation (const DtVrfObject *) const
	Returns slot information for potentially embarked entity.
virtual bool	blocked (int iSlot) const
	Returns true if this slot is blocked from being occupied because another slot is taken.
virtual void	addSlotExclusion (const DtSlotExclusion &)
virtual bool	canEmbark (const DtEmbarkationSlotEntry *, const DtVrfObject *) const
	Returns true if given object can embark in the specified slot.
virtual bool	reserveSlot (int iSlot, const DtString &)
	Reserves this slot and returns the result of reservation.
virtual void	addIngressPoint (const DtLoadPoint &)
virtual void	ingressPoints (int iSlot, const DtVrfObject *embarkingObject, const DtVrfObject *hostObject, DtEmbarkationSlotInformation &info) const
	Chooses the best ingress for the specified slot, and fills it into <info>.
virtual void	addEgressPoint (const DtLoadPoint &)
virtual void	egressPoints (int iSlot, DtEmbarkationSlotInformation &info) const
virtual void	giveUpSlot (int, const DtString &)
	Gives slot back for reservation.
virtual DtEmbarkationSlotManager *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Override to make sure that this object can be copie when PSR is copied.
virtual void	calculateDisembarkPositions (const std::list< DtString > &, DtSimManager *)
	Calculates the grid size and spacing for objects that are being disembarked via disembark all.
virtual DtVector	nextDisembarkPosition (const DtVrfObject *parent, const DtVrfObject *disembarking, const DtSimManager *simMgr, const DtVector &lastBodyPos, bool tasked, bool flipBodyX=false, bool flipBodyY=false)
	Returns the next disembark final position (in body coordinates).
virtual void	setScalingFactor (double)
	Scale factor that is applied to the bounding volume of the grid so that there can be some space between each object.
virtual double	scalingFactor () const
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.

Protected Member Functions
virtual void	calculateGridSize (const std::list< DtString > &, DtSimManager *)
	Calculates grid size as sqrt of the number of disembarking objects, using the ceiling of that value.
virtual void	calculateGridCellSize (const std::list< DtString > &, DtSimManager *)
	Calculates the space to fill once cell as the maximum bounding volume (length, width, height) of all objects that are scheduled to disembark.
virtual DtDcm	finalPositionTransformationMatrix (const DtVrfObject *parent, const DtVector &lastBodyPos) const
	Calculates the transformation matrix used to transform the final disembarkation position to body coordinates.
virtual bool	slotMatches (const DtLoadPoint *, int iSlot) const
	Returns true if the slot is found in the load point.
virtual void	putData (FILE *fp, int indentLevel=0)
	Override to create and restore lists of embarked slots.
virtual bool	blocked (int iSlot, const DtSlotExclusion &) const
virtual const DtLoadPoint *	bestIngressFor (const DtLoadPoint *ingressA, const DtLoadPoint *ingressB, const DtVrfObject *embarkingObject, const DtVrfObject *hostObject) const
virtual DtVector	bodyPositionToLocalPosition (const DtVector &bodyPosition, const DtVrfObject *body) const
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
DtEmbarkationSlotEntryMap	mySlots
DtRwTemplatedListPtr< DtLoadPoint >	myIngressPoints
DtRwTemplatedListPtr< DtLoadPoint >	myEgressPoints
DtRwTemplatedListPtr < DtSlotExclusion >	mySlotExclusions
DtRwVector	myDisembarkGridSize
	Disembark position variables; Currently only uses x, y varaibles.
DtRwVector	myDisembarkGridCellSize
	Currently only uses x, y variables for spacing.
DtRwInt	myDisembarkGridCell
	The currently disembarking grid cell to use.
DtRwTemplatedListPtr < DtReservedSlot >	myReservedSlots
	Only valid for load/get time.
double	myScalingFactor
	Local variables.
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.

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 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 ()
static DtReaderWriterFactory *	factory ()
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

Constructor & Destructor Documentation

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

DtEmbarkationSlotManager::DtEmbarkationSlotManager	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

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

copy constructor

DtEmbarkationSlotManager::DtEmbarkationSlotManager	(	const DtSymbolString &	name,
		const DtEmbarkationSlotManager &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtEmbarkationSlotManager::~DtEmbarkationSlotManager ( )

virtual

Member Function Documentation

virtual void DtEmbarkationSlotManager::addSlot ( int  iSlot, const DtEmbarkationSlotEntry *    )

virtual

virtual DtEmbarkationSlotInformation DtEmbarkationSlotManager::slotFor ( const DtVrfObject *  embarkingObject, const DtVrfObject *  hostObject  ) const

virtual

Parameters

embarkingObject	is the object which is embarking.
hostObject	is the object onto which embarkingObject wishs to embark.

virtual DtEmbarkationSlotInformation DtEmbarkationSlotManager::entityEmbarkationSlotInformation ( const DtVrfObject *  ) const

virtual

Returns slot information for potentially embarked entity.

virtual bool DtEmbarkationSlotManager::blocked ( int  iSlot ) const

virtual

Returns true if this slot is blocked from being occupied because another slot is taken.

virtual void DtEmbarkationSlotManager::addSlotExclusion ( const DtSlotExclusion &  )

virtual

virtual bool DtEmbarkationSlotManager::canEmbark ( const DtEmbarkationSlotEntry *  , const DtVrfObject *    ) const

virtual

Returns true if given object can embark in the specified slot.

virtual bool DtEmbarkationSlotManager::reserveSlot ( int  iSlot, const DtString &    )

virtual

Reserves this slot and returns the result of reservation.

virtual void DtEmbarkationSlotManager::addIngressPoint ( const DtLoadPoint &  )

virtual

virtual void DtEmbarkationSlotManager::ingressPoints ( int  iSlot, const DtVrfObject *  embarkingObject, const DtVrfObject *  hostObject, DtEmbarkationSlotInformation &  info  ) const

virtual

Chooses the best ingress for the specified slot, and fills it into <info>.

virtual void DtEmbarkationSlotManager::addEgressPoint ( const DtLoadPoint &  )

virtual

virtual void DtEmbarkationSlotManager::egressPoints ( int  iSlot, DtEmbarkationSlotInformation &  info  ) const

virtual

virtual void DtEmbarkationSlotManager::giveUpSlot ( int  , const DtString &    )

virtual

Gives slot back for reservation.

virtual DtEmbarkationSlotManager* DtEmbarkationSlotManager::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  )

virtual

Override to make sure that this object can be copie when PSR is copied.

virtual void DtEmbarkationSlotManager::calculateDisembarkPositions ( const std::list< DtString > &  , DtSimManager *    )

virtual

Calculates the grid size and spacing for objects that are being disembarked via disembark all.

Once this is called, all variables are initialized to start from scratch.

virtual DtVector DtEmbarkationSlotManager::nextDisembarkPosition ( const DtVrfObject *  parent, const DtVrfObject *  disembarking, const DtSimManager *  simMgr, const DtVector &  lastBodyPos, bool  tasked, bool  flipBodyX = false, bool  flipBodyY = false  )

virtual

Returns the next disembark final position (in body coordinates).

Uses the reference of the last disembark spot to calculate based on grid cell size and current grid position. If takes is true, extra buffering (scale factor rows) is added to make sure that collision avoidance does not interfere with getting off of entity. If flipBodyX or Y is true the value of body x or y is negated from the default value before applying transformation

virtual void DtEmbarkationSlotManager::setScalingFactor ( double  )

virtual

Scale factor that is applied to the bounding volume of the grid so that there can be some space between each object.

Default is 2.0

virtual double DtEmbarkationSlotManager::scalingFactor ( ) const

virtual

virtual void DtEmbarkationSlotManager::calculateGridSize ( const std::list< DtString > &  , DtSimManager *    )

protectedvirtual

Calculates grid size as sqrt of the number of disembarking objects, using the ceiling of that value.

virtual void DtEmbarkationSlotManager::calculateGridCellSize ( const std::list< DtString > &  , DtSimManager *    )

protectedvirtual

Calculates the space to fill once cell as the maximum bounding volume (length, width, height) of all objects that are scheduled to disembark.

virtual DtDcm DtEmbarkationSlotManager::finalPositionTransformationMatrix ( const DtVrfObject *  parent, const DtVector &  lastBodyPos  ) const

protectedvirtual

Calculates the transformation matrix used to transform the final disembarkation position to body coordinates.

virtual bool DtEmbarkationSlotManager::slotMatches ( const DtLoadPoint *  , int  iSlot  ) const

protectedvirtual

Returns true if the slot is found in the load point.

virtual void DtEmbarkationSlotManager::putData ( FILE *  fp, int  indentLevel = 0  )

protectedvirtual

Override to create and restore lists of embarked slots.

Reimplemented from DtReaderWriter.

virtual bool DtEmbarkationSlotManager::blocked ( int  iSlot, const DtSlotExclusion &    ) const

protectedvirtual

virtual const DtLoadPoint* DtEmbarkationSlotManager::bestIngressFor ( const DtLoadPoint *  ingressA, const DtLoadPoint *  ingressB, const DtVrfObject *  embarkingObject, const DtVrfObject *  hostObject  ) const

protectedvirtual

Returns

The pointer to the ingress (of the two provided) that is most appropriate for use with embarkingObject. This is based on choosing the ingress with the shortest distance between the object and the first point of the ingress route.

Parameters

hostObject

is the entity on which the embarkingObject is trying to embark.

virtual DtVector DtEmbarkationSlotManager::bodyPositionToLocalPosition ( const DtVector &  bodyPosition, const DtVrfObject *  body  ) const

protectedvirtual

Returns

The position in local coordinates of the body position specified relative to the body object.

Member Data Documentation

DtEmbarkationSlotEntryMap DtEmbarkationSlotManager::mySlots

protected

DtRwTemplatedListPtr<DtLoadPoint> DtEmbarkationSlotManager::myIngressPoints

protected

DtRwTemplatedListPtr<DtLoadPoint> DtEmbarkationSlotManager::myEgressPoints

protected

DtRwTemplatedListPtr<DtSlotExclusion> DtEmbarkationSlotManager::mySlotExclusions

protected

DtRwVector DtEmbarkationSlotManager::myDisembarkGridSize

protected

Disembark position variables; Currently only uses x, y varaibles.

DtRwVector DtEmbarkationSlotManager::myDisembarkGridCellSize

protected

Currently only uses x, y variables for spacing.

DtRwInt DtEmbarkationSlotManager::myDisembarkGridCell

protected

The currently disembarking grid cell to use.

DtRwTemplatedListPtr<DtReservedSlot> DtEmbarkationSlotManager::myReservedSlots

protected

Only valid for load/get time.

double DtEmbarkationSlotManager::myScalingFactor

protected

Local variables.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/embarkationSlotManager.h