Inheritance diagram for DtEmbarkationSlotManager:

Public Types
typedef DtRwTemplatedListPtr < DtReservedSlot, true >	DtReservedSlotList

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

Public Member Functions
	DtEmbarkationSlotManager (const DtString &name, DtReaderWriterRegistry parentRegistry=NULL, DtSimulationServices services=nullptr)

	DtEmbarkationSlotManager (const DtSymbolString &name, DtReaderWriterRegistry parentRegistry=NULL, DtSimulationServices services=nullptr)

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

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

virtual	~DtEmbarkationSlotManager ()

virtual void	addSlot (int iSlot, const DtEmbarkationSlotEntry *)

virtual DtEmbarkationSlotInformation	slotFor (const DtSimObject embarkingObject, const DtSimObject hostObject) const

virtual DtEmbarkationSlotInformation	slotFor (int slot, const DtSimObject embarkingObject, const DtSimObject hostObject) const

virtual DtEmbarkationSlotInformation	slotFor (const DtString &slotName, const DtString &slotType, const DtSimObject embarkingObject, const DtSimObject hostObject) const

virtual DtEmbarkationSlotInformation	entityEmbarkationSlotInformation (const DtUUID &) const

virtual std::vector < DtEmbarkationSlotInformation >	slotInformationFor (const DtEntityType &) const

virtual bool	blocked (int iSlot) const

virtual void	addSlotExclusion (const DtSlotExclusion &)

virtual bool	canEmbark (const DtEmbarkationSlotEntry , const DtSimObject ) const

virtual bool	canEmbark (const DtEmbarkationSlotEntry *, const DtObjectType &) const

virtual bool	available (int, const DtUUID &uuid=DtUUID::nullUUID()) const

virtual bool	reserved (int) const

virtual bool	reserveSlot (int iSlot, const DtUUID &)

virtual void	addIngressPoint (const DtLoadPoint &)

virtual void	ingressPoints (int iSlot, const DtSimObject embarkingObject, const DtSimObject hostObject, DtEmbarkationSlotInformation &info) const

virtual void	addEgressPoint (const DtLoadPoint &)

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

virtual void	giveUpSlot (int, const DtUUID &)

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

virtual void	calculateDisembarkPositions (const std::vector< DtSimObjectReference > &)

virtual DtVector	nextDisembarkPosition (const DtSimObject parent, const DtSimObject disembarking, const DtVector &lastBodyPos, bool tasked, bool flipBodyX=false, bool flipBodyY=false)

virtual void	setScalingFactor (double)

virtual double	scalingFactor () const

const DtEmbarkationSlotEntryMap &	slots () const

const DtRwTemplatedListPtr < DtLoadPoint, true > &	ingressPoints () const

const DtRwTemplatedListPtr < DtLoadPoint, true > &	egressPoints () const

const DtRwTemplatedListPtr < DtSlotExclusion, true > &	slotExclustions () const

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	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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)

Protected Member Functions
virtual void	calculateGridSize (const std::vector< DtSimObjectReference > &)

virtual void	calculateGridCellSize (const std::vector< DtSimObjectReference > &)

virtual DtDcm	finalPositionTransformationMatrix (const DtSimObject *parent, const DtVector &lastBodyPos) const

virtual bool	matchesNameAndType (const DtString &name, const DtString &type, const DtEmbarkationSlotEntry *) const

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

virtual void	putData (std::string &fp, int indentLevel=0)

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

virtual const DtLoadPoint *	bestIngressFor (const DtLoadPoint ingressA, const DtLoadPoint ingressB, const DtSimObject embarkingObject, const DtSimObject hostObject) const

virtual DtVector	bodyPositionToLocalPosition (const DtVector &bodyPosition, const DtSimObject *body) const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
tbb::spin_rw_mutex	mySlotsMutex

DtEmbarkationSlotEntryMap	mySlots

DtRwTemplatedListPtr < DtLoadPoint, true >	myIngressPoints

DtRwTemplatedListPtr < DtLoadPoint, true >	myEgressPoints

DtRwTemplatedListPtr < DtSlotExclusion, true >	mySlotExclusions

DtRwVector	myDisembarkGridSize

DtRwVector	myDisembarkGridCellSize

DtRwInt	myDisembarkGridCell

DtReservedSlotList	myReservedSlots

double	myScalingFactor

DtSimulationServices *	mySimulationServices

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

Additional Inherited Members
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)

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

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtReservedSlot, true> DtEmbarkationSlotManager::DtReservedSlotList

Constructor & Destructor Documentation

DtEmbarkationSlotManager::DtEmbarkationSlotManager	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		DtSimulationServices *	services = `nullptr`
	)

DtEmbarkationSlotManager::DtEmbarkationSlotManager	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		DtSimulationServices *	services = `nullptr`
	)

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 DtSimObject *	embarkingObject,
		const DtSimObject *	hostObject
	)		const

virtual

Parameters

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

virtual DtEmbarkationSlotInformation DtEmbarkationSlotManager::slotFor	(	int	slot,
		const DtSimObject *	embarkingObject,
		const DtSimObject *	hostObject
	)		const

virtual

Information for the given slot.

virtual DtEmbarkationSlotInformation DtEmbarkationSlotManager::slotFor	(	const DtString &	slotName,
		const DtString &	slotType,
		const DtSimObject *	embarkingObject,
		const DtSimObject *	hostObject
	)		const

virtual

This will return the first available slot that matches the slot name and type criteria. An empty string or a * will be a wild card.

virtual DtEmbarkationSlotInformation DtEmbarkationSlotManager::entityEmbarkationSlotInformation ( const DtUUID & ) const

virtual

Returns slot information for potentially embarked entity.

virtual std::vector<DtEmbarkationSlotInformation> DtEmbarkationSlotManager::slotInformationFor ( const DtEntityType & ) const

virtual

Returns all slot information for the given entity type.

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 DtSimObject *
	)		const

virtual

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

virtual bool DtEmbarkationSlotManager::canEmbark	(	const DtEmbarkationSlotEntry *	,
		const DtObjectType &
	)		const

virtual

virtual bool DtEmbarkationSlotManager::available	(	int	,
		const DtUUID &	uuid = `DtUUID::nullUUID()`
	)		const

virtual

Returns true if this slot is available. If a UUID is specified, if the slot is not available but is occupied by the entity with that UUID, will still return true.

virtual bool DtEmbarkationSlotManager::reserved ( int ) const

virtual

Returns true if there is something in this slot. Note that it can be reserved and available if the number of entities that can be in this slot is infinite.

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

virtual

Reserves this slot and returns the result of reservation.

virtual void DtEmbarkationSlotManager::addIngressPoint ( const DtLoadPoint & )

virtual

virtual void DtEmbarkationSlotManager::ingressPoints	(	int	iSlot,
		const DtSimObject *	embarkingObject,
		const DtSimObject *	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 DtUUID &
	)

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 copied when PSR is copied.

virtual void DtEmbarkationSlotManager::calculateDisembarkPositions ( const std::vector< DtSimObjectReference > & )

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 DtSimObject *	parent,
		const DtSimObject *	disembarking,
		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

const DtEmbarkationSlotEntryMap& DtEmbarkationSlotManager::slots ( ) const

inline

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

inline

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

inline

const DtRwTemplatedListPtr<DtSlotExclusion,true>& DtEmbarkationSlotManager::slotExclustions ( ) const

inline

virtual void DtEmbarkationSlotManager::calculateGridSize ( const std::vector< DtSimObjectReference > & )

protectedvirtual

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

virtual void DtEmbarkationSlotManager::calculateGridCellSize ( const std::vector< DtSimObjectReference > & )

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 DtSimObject *	parent,
		const DtVector &	lastBodyPos
	)		const

protectedvirtual

Calculates the transformation matrix used to transform the final disembarkation position to body coordinates. As of 4.3: not used.

virtual bool DtEmbarkationSlotManager::matchesNameAndType	(	const DtString &	name,
		const DtString &	type,
		const DtEmbarkationSlotEntry *
	)		const

protectedvirtual

Returns true if the name/type match the entry.

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	(	std::string &	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 DtSimObject *	embarkingObject,
		const DtSimObject *	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 DtSimObject *	body
	)		const

protectedvirtual

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

Member Data Documentation

tbb::spin_rw_mutex DtEmbarkationSlotManager::mySlotsMutex

mutableprotected

DtEmbarkationSlotEntryMap DtEmbarkationSlotManager::mySlots

protected

DtRwTemplatedListPtr<DtLoadPoint,true> DtEmbarkationSlotManager::myIngressPoints

protected

DtRwTemplatedListPtr<DtLoadPoint,true> DtEmbarkationSlotManager::myEgressPoints

protected

DtRwTemplatedListPtr<DtSlotExclusion,true> DtEmbarkationSlotManager::mySlotExclusions

protected

DtRwVector DtEmbarkationSlotManager::myDisembarkGridSize

protected

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

DtRwVector DtEmbarkationSlotManager::myDisembarkGridCellSize

protected

Currently only uses x, y variables for spacing.

DtRwInt DtEmbarkationSlotManager::myDisembarkGridCell

protected

The currently disembarking grid cell to use.

DtReservedSlotList DtEmbarkationSlotManager::myReservedSlots

protected

Only valid for load/get time.

double DtEmbarkationSlotManager::myScalingFactor

protected

Local variables.

DtSimulationServices* DtEmbarkationSlotManager::mySimulationServices

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/embarkationSlotManager.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation