DtEmbarkationDescriptor Class Reference

Instances of DtEmbarkationDescriptor are used to specify the parameters for a DtEmbarkationController object. More...

Inheritance diagram for DtEmbarkationDescriptor:

Public Member Functions
	DtEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor More...
	DtEmbarkationDescriptor (const DtEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
DtEmbarkationDescriptor &	operator= (const DtEmbarkationDescriptor &orig)
	assignment More...
virtual	~DtEmbarkationDescriptor ()
	destructor More...
virtual DtString	type () const
	Returns the type of component this descriptor describes. More...
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual double	responseTimeout () const
	Accessor/mutator for myResponseTimeout. More...
virtual void	setResponseTimeout (double value)
virtual int	responseRetries () const
	Accessor/mutator for myResponseRetries. More...
virtual void	setResponseRetries (int value)
virtual const DtRwStringAttributeList &	techniqueMap () const
	Accessor/mutator for myTechniqueMap. More...
virtual DtRwStringAttributeList &	techniqueMap ()
virtual bool	stopAtEmbarkationPoint () const
	Accessor/mutator for myStopAtEmbarkationPoint. More...
virtual void	setStopAtEmbarkationPoint (bool value)
virtual bool	invisibleAtOrigin () const
	Accessor/mutator for myInvisibleAtOrigin. More...
virtual void	setInvisibleAtOrigin (bool value)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment More...
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored. More...
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. More...
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. More...
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	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime. More...
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR. More...
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create. More...
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not. More...
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component. More...
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)
	Should the component be created or not. More...
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object. More...
virtual bool	createOnRemoteObject () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
virtual void	writeSelf (std::string &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. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag. More...
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
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. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
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. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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())
	Gets data from the environment value. More...
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

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. More...
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. More...
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class. More...
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor. More...
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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myResponseTimeout
	Parameter Name: response-timeout Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request. More...
DtRwInt	myResponseRetries
	Parameter Name: response-retries Parameter Description: Sets the number of retries for sending an embarkation response request. More...
DtRwBoolean	myStopAtEmbarkationPoint
	Parameter Name: stop-at-embarkation-point Parameter Description: Specifies whether the entity should perform a full stop when it reaches the embarkation point prior to embarking. More...
DtRwBoolean	myInvisibleAtOrigin
	Parameter Name: invisible-at-origin Parameter Description: Specifies whether or not the object embarked will be invisible if embarked at the origin of an entity (0, 0, 0). More...
DtRwStringAttributeList	myTechniqueMap
	Parameter Name: technique-map Parameter Description: Map between a technique for embark/disembark given to a slot and returned in he occupancy director controller response to the scripted task that will be executed for that technique. More...
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component. More...
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component. More...
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. More...
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. More...
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. More...
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. More...
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. More...
DtRwBoolean	myDebug
	This parameter defaults to false. More...
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. More...
DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled. More...
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. More...
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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Private Member Functions
	DtEmbarkationDescriptor ()
	default constructor; not implemented More...

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 )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented More...
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
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

Detailed Description

Instances of DtEmbarkationDescriptor are used to specify the parameters for a DtEmbarkationController object.

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtEmbarkationDescriptor::~DtEmbarkationDescriptor ( )

virtual

destructor

DtEmbarkationDescriptor::DtEmbarkationDescriptor ( )

private

default constructor; not implemented

Member Function Documentation

DtEmbarkationDescriptor& DtEmbarkationDescriptor::operator=

(

const DtEmbarkationDescriptor &

orig

)

assignment

virtual DtString DtEmbarkationDescriptor::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

DtEmbarkationDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtAggregateEmbarkationDescriptor.

virtual DtComponentDescriptor* DtEmbarkationDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtAggregateEmbarkationDescriptor.

static DtComponentDescriptor* DtEmbarkationDescriptor::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 double DtEmbarkationDescriptor::responseTimeout ( ) const

virtual

Accessor/mutator for myResponseTimeout.

virtual void DtEmbarkationDescriptor::setResponseTimeout ( double  value )

virtual

virtual int DtEmbarkationDescriptor::responseRetries ( ) const

virtual

Accessor/mutator for myResponseRetries.

virtual void DtEmbarkationDescriptor::setResponseRetries ( int  value )

virtual

virtual const DtRwStringAttributeList& DtEmbarkationDescriptor::techniqueMap ( ) const

virtual

Accessor/mutator for myTechniqueMap.

virtual DtRwStringAttributeList& DtEmbarkationDescriptor::techniqueMap ( )

virtual

virtual bool DtEmbarkationDescriptor::stopAtEmbarkationPoint ( ) const

virtual

Accessor/mutator for myStopAtEmbarkationPoint.

virtual void DtEmbarkationDescriptor::setStopAtEmbarkationPoint ( bool  value )

virtual

virtual bool DtEmbarkationDescriptor::invisibleAtOrigin ( ) const

virtual

Accessor/mutator for myInvisibleAtOrigin.

virtual void DtEmbarkationDescriptor::setInvisibleAtOrigin ( bool  value )

virtual

Member Data Documentation

DtRwReal DtEmbarkationDescriptor::myResponseTimeout

protected

Parameter Name: response-timeout
Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request.

Parameter Default Value: 1.0
Parameter Units: seconds

DtRwInt DtEmbarkationDescriptor::myResponseRetries

protected

Parameter Name: response-retries
Parameter Description: Sets the number of retries for sending an embarkation response request.

Parameter Default Value: 1

DtRwBoolean DtEmbarkationDescriptor::myStopAtEmbarkationPoint

protected

Parameter Name: stop-at-embarkation-point
Parameter Description: Specifies whether the entity should perform a full stop when it reaches the embarkation point prior to embarking.

Parameter Default Value: True
Parameter Units: True/False

DtRwBoolean DtEmbarkationDescriptor::myInvisibleAtOrigin

protected

Parameter Name: invisible-at-origin
Parameter Description: Specifies whether or not the object embarked will be invisible if embarked at the origin of an entity (0, 0, 0).

Parameter Default Value: True
Parameter Units: True/False

DtRwStringAttributeList DtEmbarkationDescriptor::myTechniqueMap

protected

Parameter Name: technique-map
Parameter Description: Map between a technique for embark/disembark given to a slot and returned in he occupancy director controller response to the scripted task that will be executed for that technique.

Parameter Default Value:

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjparam/embarkationDescriptor.h