DtVrfObjectParameters Class Reference

Instances of DtVrfObjectParameters are the readable/writeable objects that contain the information necessary to construct a DtVrfObject. More...

Inheritance diagram for DtVrfObjectParameters:

Public Types
typedef DtRwTemplatedListPtr < DtRwAutoConnection >	DtAutoConnectionsListPtr
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 )()

Public Member Functions
	DtVrfObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtVrfObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
virtual	~DtVrfObjectParameters ()
	destructor
DtVrfObjectParameters &	operator= (const DtVrfObjectParameters &orig)
	assignment operator
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	init ()
	Invoked when created so that deriving classes may do virtual allocation as necessary.
virtual DtString	type () const
	Returns a string identifying the type of parameter descriptor.
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy.
virtual void	inheritValuesFromThisType (const DtVrfObjectParameters *benefactor)
virtual bool	createLocalSubComponentTypes ()
	Creates a DtVrfObjectSubComponentTypes type of composed object type.
virtual bool	createRemoteSubComponentTypes ()
	Creates a DtVrfObjectSubComponentTypes type of composed object type.
virtual DtVrfObjectSubComponentTypes *	localVrfSubComponentTypes () const
	Get local sub-component types.
virtual DtVrfObjectSubComponentTypes *	remoteVrfSubComponentTypes () const
	Get remote sub-component types.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
	Set the minimum tick period for this object (individual components and the network interface may override)
virtual DtReal	minTickPeriod () const
	get the minimum tick period for this component (individual components and the network interface may override)
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
	Set the minimum tick period variance for this component (individual components and the network interface may override)
virtual DtReal	minTickPeriodVariance () const
	Get the minimum tick period variance for this component (individual components and the network interface may override)
virtual DtForceType	forceType () const
	Currently unused.
virtual void	setForceType (const DtForceType force)
virtual const DtString &	category () const
	Accessor/mutator for myCategory.
virtual void	setCategory (const DtString &category)
virtual bool	categorySpecified () const
	Returns true of the category was specified in the file.
virtual const DtString &	echelonLevel () const
	Accessor/mutator for myEchelonLevel.
virtual void	setEchelonLevel (const DtString &echelonLevel)
virtual bool	echelonLevelSpecified () const
	Returns true of the echelon level was specified in the file.
virtual bool	organized () const
	Accessor/mutator for myOrganized.
virtual void	setOrganized (bool organized)
virtual const DtComponentDescriptorList &	sensorDescriptorList () const
	Accessor/mutator for mySensorDescriptorList.
virtual DtComponentDescriptorList &	sensorDescriptorList ()
virtual void	setSensorDescriptorList (const DtComponentDescriptorList &list)
virtual const DtComponentDescriptorList &	controllerDescriptorList () const
	Accessor/mutator for myControllerDescriptorList.
virtual DtComponentDescriptorList &	controllerDescriptorList ()
virtual void	setControllerDescriptorList (const DtComponentDescriptorList &list)
virtual const DtComponentDescriptorList &	actuatorDescriptorList () const
	Accessor/mutator for myActuatorDescriptorList.
virtual DtComponentDescriptorList &	actuatorDescriptorList ()
virtual void	setActuatorDescriptorList (const DtComponentDescriptorList &list)
virtual const DtConnectionDescriptorList &	connectionDescriptorList () const
	Accessor/mutator for myConnectionDescriptorList.
virtual DtConnectionDescriptorList &	connectionDescriptorList ()
virtual void	setConnectionDescriptorList (const DtConnectionDescriptorList &list)
virtual DtDeadReckonTypes	deadReckoningAlgorithm () const
	Accessor/mutator for myDeadReckoningAlgorithm.
virtual void	setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
virtual const DtRwDeadReckonThresholds &	deadReckoningThresholds () const
	Accessor/mutator for myDeadReckoningThresholds.
virtual void	setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds)
virtual DtReal	mass () const
	Accessor/mutator for myMass.
virtual void	setMass (const DtReal mass)
virtual const DtRwSensorSignatureList &	sensorSignatureList () const
	Accessor/mutator for mySensorSignatureList.
virtual DtRwSensorSignatureList &	sensorSignatureList ()
virtual const DtVrfSubObjectParameterList &	subordinateObjects () const
	List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.)
virtual void	setSubordinateObjects (const DtVrfSubObjectParameterList &subordinateObjects)
virtual const DtVrfSubObjectParameterList &	attachedObjects () const
	Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored.
virtual void	setAttachedObjects (const DtVrfSubObjectParameterList &attachedObjects)
virtual DtVrfObjectSubComponentTypes *	localSubComponentTypes () const
	Get local sub-component types.
virtual DtVrfObjectSubComponentTypes *	remoteSubComponentTypes () const
	Get remote sub-component types.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
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 actual stored.
virtual const Dt3dBoundingVolume *	boundingVolume () const
	Set/get the bounding volume of the object.
virtual void	setBoundingVolume (const Dt3dBoundingVolume &newBoundingVolume)
	Set the bounding volume of the object.
virtual void	setBoundingVolume (const DtVector &localBvolDiagonal, const DtVector &offset=DtVector::zero())
	Set the bounding volume from its components.
virtual DtSimBoundingGeometry::DtSimBoundingGeometryType	boundingGeometryType () const
	Set/get the bounding geometry type of the object.
virtual void	setBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type)
virtual double	draft () const
	For convenience– computes the draft from bounding volume.
virtual DtAggregateFormation	formation () const
	Accessor/mutator for myFormationType.
virtual void	setFormation (DtAggregateFormation formation)
virtual const DtString &	engagementRules () const
	Accessor/mutator for myEngagementRules.
virtual void	setEngagementRules (const DtString &engagementRules)
virtual const DtSimResourceManager &	resourceManager () const
	Accessor/mutator for myResourceManager.
virtual void	setResourceManager (const DtSimResourceManager &resourceManager)
virtual void	setStateRepositoryUserExtensionType (const DtString &type)
	Accessor/mutator for myStateRepositoryUserExtensionType.
virtual const DtString &	stateRepositoryUserExtensionType () const
virtual DtObjectType	objectType () const
	Accessor/mutator for myObjectType.
virtual void	setObjectType (const DtObjectType &objectType)
virtual DtObjectType	matchType () const
	Accessor/mutator for myMatchType.
virtual void	setMatchType (const DtObjectType &objectType)
virtual bool	taskedBySuperiorUponTaskComplete () const
	Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task).
virtual void	setTaskedBySuperiorUponTaskComplete (bool trueOrFalse)
void	setParameterType (const DtString &)
	Sets/gets type of parameter.
const DtString &	parameterType () const
virtual void	setStateRepositoryUserExtension (const DtVrfStateRepositoryUserExtension &userExtension)
	State repository user extension data (extensible at the base class DtVrfObjectStateRepository).
virtual DtVrfStateRepositoryUserExtension *	stateRepositoryUserExtension () const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters.
virtual DtTime	underFireTime () const
virtual void	setUnderFireTime (DtTime time)
virtual bool	underFireTimeSpecified () const
virtual DtReal	underFireDistance () const
virtual void	setUnderFireDistance (DtReal underFireDistance)
virtual bool	underFireDistanceSpecified () const
virtual const DtAutoConnectionsListPtr &	autoConnections () const
virtual DtAutoConnectionsListPtr &	autoConnections ()
virtual const std::list < DtSimArtPartDescriptor * > *	completeArtPartList () const
virtual void	connectSystems ()
	Creates entity-level connections between systems based on sysdef metadata.
bool	operator== (const DtVrfObjectParameters &) const
	Equality operator. Simply compares the contents of the registry.
bool	operator!= (const DtVrfObjectParameters &) const
virtual DtEnvironmentSP	xmlEnvironment ()
virtual const DtComponentSystemDescriptorList &	systemDescriptorList () const
	See mySystemDescriptorList.
virtual DtComponentSystemDescriptorList &	systemDescriptorList ()
	See mySystemDescriptorList.
virtual void	setSystemDescriptorList (const DtComponentSystemDescriptorList &list)
	See mySystemDescriptorList.
virtual const DtRwBoolean	deadReckoningAllowGuiOverrides () const
	Accessor/mutator for myDeadReckoningAllowGuiOverrides.
virtual void	setDeadReckoningAllowGuiOverrides (bool allow)
	Accessor/mutator for myDeadReckoningAllowGuiOverrides.
virtual const DtRadioDescriptorList &	radioDescriptorList () const
	See myRadioDescriptorList.
virtual DtRadioDescriptorList &	radioDescriptorList ()
	See myRadioDescriptorList.
virtual const DtSimSector &	initialSectorOfResponsibility () const
virtual void	setInitialSectorOfResponsibility (const DtSimSector &sor)
virtual DtTaskExecutionRules &	taskExecutionRules ()
virtual const DtTaskExecutionRules &	taskExecutionRules () const
virtual void	setTaskExecutionRulesFilename (const DtFilename &)
virtual const DtReaderWriterFile &	taskExecutionRulesFilename () 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.

Static Public Member Functions
static DtVrfObjectParameters *	createParameters (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
static DtVrfObjectParameters *	createParameters (const char *name, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
static DtVrfObjectParameterFactory *	factory ()
static void	setFactory (DtVrfObjectParameterFactory *factory)
static void	addParameterCreatorFcn (const DtString &type, DtSimObjectParametersCreatorFcn fcn)
static DtVrfObjectParameters *	creator (DtEnvironmentSP env, DtEnvValueSP *objectNode)
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
	DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor. Use clone instead.
	DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtVrfSubObjectParameterList *	createSubordinateObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
	Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init().
virtual DtVrfSubObjectParameterList *	createAttachedObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
	Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init().
virtual void	rebuildArtPartList ()
	Clears out and rebuilds myCompleteArtPartList.
virtual void	addArtPartsFromSystem (DtComponentSystemDescriptor *systemDesc, std::list< DtSimArtPartDescriptor * > &artPartList)
	Adds any art parts defined within a system to the list.
virtual void	createAutomaticConnections (DtRwAutoConnection *autoConnection)
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
DtObjectType	myMatchType
	An extended form of the DIS/RPR FOM entity enumerated type.
DtObjectType	myObjectType
DtTaskExecutionRules	myTaskExecutionRules
	Task execution rules.
DtString	myParameterType
	String that keeps the type of parameter this is Local only – not part of descriptor.
std::list < DtSimArtPartDescriptor * >	myCompleteArtPartList
	A list containing all the art part descriptors from actuators directly on the entity and those in systems as well.
DtEnvValueSP *	myObjectNode
DtEnvironmentSP	myEnvironment
DtAutoConnectionsListPtr	myAutoConnections
parameters
These parameters are available for setting in the OPD files.
DtRwBoundingGeometryType	myBoundingGeometryType
	Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).
DtRwBoundingVolume	myBvol
	Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object.
DtVrfObjectSubComponentTypes *	myLocalSubComponentTypes
	Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects.
DtVrfObjectSubComponentTypes *	myRemoteSubComponentTypes
	Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects.
DtRwFormationType	myFormationType
	Parameter Name: formation Parameter Description: (Optional) One of the following:
DtRwForceType	myForceType
	Parameter Name: force-type Parameter Description: The force to which the object belongs.
DtRwString	myCategory
	Parameter Name: category Parameter Description: The category string to use when creating an echelon ID.
DtRwString	myEchelonLevel
	Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID.
DtRwBoolean	myOrganized
	Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary.
DtRwDeadReckonTypes	myDeadReckoningAlgorithm
	Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity.
DtRwDeadReckonThresholds	myDeadReckoningThresholds
	Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity.
DtRwBoolean	myDeadReckoningAllowGuiOverrides
	Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).
DtRadioDescriptorList	myRadioDescriptorList
	Parameter Name: radios Parameter Description: List of all radios on the entity.
DtComponentSystemDescriptorList	mySystemDescriptorList
	Parameter Name: systems Parameter Description: List of system descriptors.
DtComponentDescriptorList	mySensorDescriptorList
	Parameter Name: sensors Parameter Description: List of sensor controller component descriptors.
DtComponentDescriptorList	myControllerDescriptorList
	Parameter Name: controllers Parameter Description: List of controller component descriptors.
DtComponentDescriptorList	myActuatorDescriptorList
	Parameter Name: actuators Parameter Description: List of actuator component descriptors.
DtConnectionDescriptorList	myConnectionDescriptorList
	Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both).
DtRwReal	myMass
	Parameter Name: mass Parameter Description: The mass of the entity.
DtRwSensorSignatureList	mySensorSignatureList
	Parameter Name: sensor-signatures Parameter Description: Parameter Default Value:
DtVrfSubObjectParameterList *	mySubordinateObjects
	Parameter Name: subordinate-objects Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object.
DtVrfSubObjectParameterList *	myAttachedObjects
	Parameter Name: attached-objects Parameter Description: Parameter Default Value: .
DtRwString	myEngagementRules
	Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message.
DtSimResourceManager	myResourceManager
	Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has.
DtRwString	myStateRepositoryUserExtensionType
	Parameter Name: state-repository-extension-type Parameter Description: Type of state repository extensions class to instantiate.
DtRwBoolean	myTaskedBySuperiorUponTaskComplete
	Parameter Name: tasked-by-superior-upon-task-complete Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task.
DtVrfStateRepositoryUserExtension *	myStateRepositoryUserExtension
	Parameter Name: user-extension Parameter Description: Extension to the state repository class.
DtRwTime	myUnderFireTime
	Parameter Name: under-fire-time Parameter Description: Deprecated.
DtRwReal	myUnderFireDistance
	Parameter Name: under-fire-distance Parameter Description: Deprecated.
DtSimSector	myInitialSectorOfResponsibility
	Parameter Name: initial-sector-of-responsibility Parameter Description: The sector of responsibility for this entity when the entity is first created.
DtReaderWriterFile	myTaskExecutionRulesFilename
	Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity.
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.

Static Protected Attributes
static DtVrfObjectParameterFactory *	theFactory
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

Detailed Description

Instances of DtVrfObjectParameters are the readable/writeable objects that contain the information necessary to construct a DtVrfObject.

Developer Description: Used to hold parameters for the DtVrfMovingObjectStateRepository class.

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwAutoConnection> DtVrfObjectParameters::DtAutoConnectionsListPtr

Constructor & Destructor Documentation

DtVrfObjectParameters::DtVrfObjectParameters	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL,
		DtEnvironmentSP	env = DtEnvironmentSP(),
		DtEnvValueSP *	objectNode = NULL
	)

Constructor with parameters to set up read/writability correctly.

DtVrfObjectParameters::DtVrfObjectParameters	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL,
		DtEnvironmentSP	env = DtEnvironmentSP(),
		DtEnvValueSP *	objectNode = NULL
	)

virtual DtVrfObjectParameters::~DtVrfObjectParameters ( )

virtual

destructor

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

protected

copy constructor. Use clone instead.

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

protected

Member Function Documentation

DtVrfObjectParameters& DtVrfObjectParameters::operator=

(

const DtVrfObjectParameters &

orig

)

assignment operator

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

virtual

Reimplemented in DtTextObjectParameters, DtCircleObjectParameters, DtLineObjectParameters, DtAreaObjectParameters, DtFixedWingEntityParameters, DtAggregateObjectParameters, DtMovingObjectParameters, DtRotaryWingEntityParameters, DtGroundVehicleParameters, DtSymbolObjectParameters, DtHumanParameters, DtCulturalFeatureParameters, DtIndividualLifeFormParameters, DtSubSurfaceEntityParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtSpaceEntityParameters, DtGlobalEnvironmentParameters, DtMissileParameters, DtBombParameters, DtScriptedMovementObjectParameters, and DtPointObjectParameters.

virtual DtVrfObjectParameters* DtVrfObjectParameters::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Reimplemented in DtTextObjectParameters, DtCircleObjectParameters, DtLineObjectParameters, DtAreaObjectParameters, DtFixedWingEntityParameters, DtMovingObjectParameters, DtAggregateObjectParameters, DtSymbolObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtRotaryWingEntityParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtGlobalEnvironmentParameters, DtHumanParameters, DtMissileParameters, DtBombParameters, DtScriptedMovementObjectParameters, DtSubSurfaceEntityParameters, and DtPointObjectParameters.

virtual bool DtVrfObjectParameters::init ( )

virtual

Invoked when created so that deriving classes may do virtual allocation as necessary.

The base class version creates the local and remote composed object types. Calls createSubordinateObjectsList() and createAttachedObjectsList() to create the mySubordinateObjects and myAttachedObjects data members, respectively.

Reimplemented in DtAggregateObjectParameters.

virtual DtString DtVrfObjectParameters::type ( ) const

virtual

Returns a string identifying the type of parameter descriptor.

Used to create the descriptor on read from a parameter database file. ((Required) The value must be in quotation marks. Type strings are defined in vrfParamTypes.h.

Returns

DtVrfObjectParamType

Reimplemented in DtTextObjectParameters, DtCircleObjectParameters, DtLineObjectParameters, DtMissileParameters, DtAreaObjectParameters, DtFixedWingEntityParameters, DtGroundVehicleParameters, DtBombParameters, DtAggregateObjectParameters, DtCulturalFeatureParameters, DtMovingObjectParameters, DtSymbolObjectParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtIndividualLifeFormParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtGlobalEnvironmentParameters, DtScriptedMovementObjectParameters, DtSubSurfaceEntityParameters, DtSpaceEntityParameters, and DtPointObjectParameters.

virtual bool DtVrfObjectParameters::inheritValues ( const DtVrfObjectParameters *  benefactor )

virtual

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy.

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from.

Reimplemented in DtTextObjectParameters, DtCircleObjectParameters, DtLineObjectParameters, DtAreaObjectParameters, DtFixedWingEntityParameters, DtMovingObjectParameters, DtSymbolObjectParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtIndividualLifeFormParameters, DtGroundVehicleParameters, DtSurfaceEntityParameters, DtCulturalFeatureParameters, DtSubSurfaceEntityParameters, DtBombParameters, DtMissileParameters, DtScriptedMovementObjectParameters, and DtPointObjectParameters.

virtual void DtVrfObjectParameters::inheritValuesFromThisType ( const DtVrfObjectParameters *  benefactor )

virtual

virtual bool DtVrfObjectParameters::createLocalSubComponentTypes ( )

virtual

Creates a DtVrfObjectSubComponentTypes type of composed object type.

virtual bool DtVrfObjectParameters::createRemoteSubComponentTypes ( )

virtual

Creates a DtVrfObjectSubComponentTypes type of composed object type.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::localVrfSubComponentTypes ( ) const

virtual

Get local sub-component types.

This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is locally simulated.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::remoteVrfSubComponentTypes ( ) const

virtual

Get remote sub-component types.

This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is simulated remotely.

virtual void DtVrfObjectParameters::setMinTickPeriod ( DtReal  minTickPeriod )

virtual

Set the minimum tick period for this object (individual components and the network interface may override)

virtual DtReal DtVrfObjectParameters::minTickPeriod ( ) const

virtual

get the minimum tick period for this component (individual components and the network interface may override)

virtual void DtVrfObjectParameters::setMinTickPeriodVariance ( DtReal  minTickPeriodVariance )

virtual

Set the minimum tick period variance for this component (individual components and the network interface may override)

virtual DtReal DtVrfObjectParameters::minTickPeriodVariance ( ) const

virtual

Get the minimum tick period variance for this component (individual components and the network interface may override)

virtual DtForceType DtVrfObjectParameters::forceType ( ) const

virtual

Currently unused.

Since entities are specified at creation time as an entity type and force type, we may go to using both as a lookup key.

virtual void DtVrfObjectParameters::setForceType ( const DtForceType  force )

virtual

virtual const DtString& DtVrfObjectParameters::category ( ) const

virtual

Accessor/mutator for myCategory.

virtual void DtVrfObjectParameters::setCategory ( const DtString &  category )

virtual

virtual bool DtVrfObjectParameters::categorySpecified ( ) const

virtual

Returns true of the category was specified in the file.

virtual const DtString& DtVrfObjectParameters::echelonLevel ( ) const

virtual

Accessor/mutator for myEchelonLevel.

virtual void DtVrfObjectParameters::setEchelonLevel ( const DtString &  echelonLevel )

virtual

virtual bool DtVrfObjectParameters::echelonLevelSpecified ( ) const

virtual

Returns true of the echelon level was specified in the file.

virtual bool DtVrfObjectParameters::organized ( ) const

virtual

Accessor/mutator for myOrganized.

virtual void DtVrfObjectParameters::setOrganized ( bool  organized )

virtual

virtual const DtComponentSystemDescriptorList& DtVrfObjectParameters::systemDescriptorList ( ) const

virtual

See mySystemDescriptorList.

virtual DtComponentSystemDescriptorList& DtVrfObjectParameters::systemDescriptorList ( )

virtual

See mySystemDescriptorList.

virtual void DtVrfObjectParameters::setSystemDescriptorList ( const DtComponentSystemDescriptorList &  list )

virtual

See mySystemDescriptorList.

virtual const DtComponentDescriptorList& DtVrfObjectParameters::sensorDescriptorList ( ) const

virtual

Accessor/mutator for mySensorDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::sensorDescriptorList ( )

virtual

virtual void DtVrfObjectParameters::setSensorDescriptorList ( const DtComponentDescriptorList &  list )

virtual

virtual const DtComponentDescriptorList& DtVrfObjectParameters::controllerDescriptorList ( ) const

virtual

Accessor/mutator for myControllerDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::controllerDescriptorList ( )

virtual

virtual void DtVrfObjectParameters::setControllerDescriptorList ( const DtComponentDescriptorList &  list )

virtual

virtual const DtComponentDescriptorList& DtVrfObjectParameters::actuatorDescriptorList ( ) const

virtual

Accessor/mutator for myActuatorDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::actuatorDescriptorList ( )

virtual

virtual void DtVrfObjectParameters::setActuatorDescriptorList ( const DtComponentDescriptorList &  list )

virtual

virtual const DtConnectionDescriptorList& DtVrfObjectParameters::connectionDescriptorList ( ) const

virtual

Accessor/mutator for myConnectionDescriptorList.

virtual DtConnectionDescriptorList& DtVrfObjectParameters::connectionDescriptorList ( )

virtual

virtual void DtVrfObjectParameters::setConnectionDescriptorList ( const DtConnectionDescriptorList &  list )

virtual

virtual DtDeadReckonTypes DtVrfObjectParameters::deadReckoningAlgorithm ( ) const

virtual

Accessor/mutator for myDeadReckoningAlgorithm.

virtual void DtVrfObjectParameters::setDeadReckoningAlgorithm ( DtDeadReckonTypes  deadReckoningAlgorithm )

virtual

virtual const DtRwBoolean DtVrfObjectParameters::deadReckoningAllowGuiOverrides ( ) const

virtual

Accessor/mutator for myDeadReckoningAllowGuiOverrides.

virtual void DtVrfObjectParameters::setDeadReckoningAllowGuiOverrides ( bool  allow )

virtual

Accessor/mutator for myDeadReckoningAllowGuiOverrides.

virtual const DtRwDeadReckonThresholds& DtVrfObjectParameters::deadReckoningThresholds ( ) const

virtual

Accessor/mutator for myDeadReckoningThresholds.

virtual void DtVrfObjectParameters::setDeadReckoningThresholds ( const DtRwDeadReckonThresholds &  deadReckoningThresholds )

virtual

virtual DtReal DtVrfObjectParameters::mass ( ) const

virtual

Accessor/mutator for myMass.

virtual void DtVrfObjectParameters::setMass ( const DtReal  mass )

virtual

virtual const DtRadioDescriptorList& DtVrfObjectParameters::radioDescriptorList ( ) const

virtual

See myRadioDescriptorList.

virtual DtRadioDescriptorList& DtVrfObjectParameters::radioDescriptorList ( )

virtual

See myRadioDescriptorList.

virtual const DtRwSensorSignatureList& DtVrfObjectParameters::sensorSignatureList ( ) const

virtual

Accessor/mutator for mySensorSignatureList.

virtual DtRwSensorSignatureList& DtVrfObjectParameters::sensorSignatureList ( )

virtual

virtual const DtVrfSubObjectParameterList& DtVrfObjectParameters::subordinateObjects ( ) const

virtual

List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.)

virtual void DtVrfObjectParameters::setSubordinateObjects ( const DtVrfSubObjectParameterList &  subordinateObjects )

virtual

virtual const DtVrfSubObjectParameterList& DtVrfObjectParameters::attachedObjects ( ) const

virtual

Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored.

virtual void DtVrfObjectParameters::setAttachedObjects ( const DtVrfSubObjectParameterList &  attachedObjects )

virtual

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::localSubComponentTypes ( ) const

virtual

Get local sub-component types.

This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is locally simulated.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::remoteSubComponentTypes ( ) const

virtual

Get remote sub-component types.

This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is simulated remotely.

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

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtVrfObjectParameters::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

getData is just used to get us past the type in the data stream, since it's not actual stored.

virtual const Dt3dBoundingVolume* DtVrfObjectParameters::boundingVolume ( ) const

virtual

Set/get the bounding volume of the object.

virtual void DtVrfObjectParameters::setBoundingVolume ( const Dt3dBoundingVolume &  newBoundingVolume )

virtual

Set the bounding volume of the object.

virtual void DtVrfObjectParameters::setBoundingVolume ( const DtVector &  localBvolDiagonal, const DtVector &  offset = DtVector::zero()  )

virtual

Set the bounding volume from its components.

This is not the preferred form, but is included for completeness.

Note

When possible, use the version which takes an entire Dt3dBoundingVolume as the parameter to protect against future changes in the bounding volume class.

virtual DtSimBoundingGeometry::DtSimBoundingGeometryType DtVrfObjectParameters::boundingGeometryType ( ) const

virtual

Set/get the bounding geometry type of the object.

virtual void DtVrfObjectParameters::setBoundingGeometryType ( DtSimBoundingGeometry::DtSimBoundingGeometryType  type )

virtual

virtual double DtVrfObjectParameters::draft ( ) const

virtual

For convenience– computes the draft from bounding volume.

Draft is the distance of the bottom of the bounding box below the origin.

virtual DtAggregateFormation DtVrfObjectParameters::formation ( ) const

virtual

Accessor/mutator for myFormationType.

virtual void DtVrfObjectParameters::setFormation ( DtAggregateFormation  formation )

virtual

virtual const DtString& DtVrfObjectParameters::engagementRules ( ) const

virtual

Accessor/mutator for myEngagementRules.

virtual void DtVrfObjectParameters::setEngagementRules ( const DtString &  engagementRules )

virtual

virtual const DtSimResourceManager& DtVrfObjectParameters::resourceManager ( ) const

virtual

Accessor/mutator for myResourceManager.

virtual void DtVrfObjectParameters::setResourceManager ( const DtSimResourceManager &  resourceManager )

virtual

virtual void DtVrfObjectParameters::setStateRepositoryUserExtensionType ( const DtString &  type )

virtual

Accessor/mutator for myStateRepositoryUserExtensionType.

virtual const DtString& DtVrfObjectParameters::stateRepositoryUserExtensionType ( ) const

virtual

virtual DtObjectType DtVrfObjectParameters::objectType ( ) const

virtual

Accessor/mutator for myObjectType.

virtual void DtVrfObjectParameters::setObjectType ( const DtObjectType &  objectType )

virtual

virtual DtObjectType DtVrfObjectParameters::matchType ( ) const

virtual

Accessor/mutator for myMatchType.

virtual void DtVrfObjectParameters::setMatchType ( const DtObjectType &  objectType )

virtual

virtual bool DtVrfObjectParameters::taskedBySuperiorUponTaskComplete ( ) const

virtual

Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task).

By default, this is set to true, so a subordinate will be immediately able to participate as part of an aggregate when it completes an independent task. The name of the parameter is 'tasked-by-superior-upon-task-complete'.

virtual void DtVrfObjectParameters::setTaskedBySuperiorUponTaskComplete ( bool  trueOrFalse )

virtual

static DtVrfObjectParameters* DtVrfObjectParameters::createParameters ( DtlObjPtr  mtlStream, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings, DtEnvironmentSP  env = DtEnvironmentSP(), DtEnvValueSP *  objectNode = NULL  )

static

static DtVrfObjectParameters* DtVrfObjectParameters::createParameters ( const char *  name, DtEnvironmentSP  env = DtEnvironmentSP(), DtEnvValueSP *  objectNode = NULL  )

static

static DtVrfObjectParameterFactory* DtVrfObjectParameters::factory ( )

static

Returns

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static void DtVrfObjectParameters::setFactory ( DtVrfObjectParameterFactory *  factory )

static

static void DtVrfObjectParameters::addParameterCreatorFcn ( const DtString &  type, DtSimObjectParametersCreatorFcn  fcn  )

static

static DtVrfObjectParameters* DtVrfObjectParameters::creator ( DtEnvironmentSP  env, DtEnvValueSP *  objectNode  )

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 in DtFixedWingEntityParameters, DtTextObjectParameters, DtCircleObjectParameters, DtLineObjectParameters, DtRotaryWingEntityParameters, DtMissileParameters, DtAreaObjectParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtBombParameters, DtCulturalFeatureParameters, DtMovingObjectParameters, DtSymbolObjectParameters, DtHumanParameters, DtScriptedMovementObjectParameters, DtSpaceEntityParameters, DtIndividualLifeFormParameters, DtTacticalSmokeParameters, DtGlobalEnvironmentParameters, DtSubSurfaceEntityParameters, DtPointObjectParameters, and DtSurfaceEntityParameters.

void DtVrfObjectParameters::setParameterType ( const DtString &  t )

inline

Sets/gets type of parameter.

References myParameterType.

const DtString & DtVrfObjectParameters::parameterType ( ) const

inline

References myParameterType.

virtual void DtVrfObjectParameters::setStateRepositoryUserExtension ( const DtVrfStateRepositoryUserExtension &  userExtension )

virtual

State repository user extension data (extensible at the base class DtVrfObjectStateRepository).

virtual DtVrfStateRepositoryUserExtension* DtVrfObjectParameters::stateRepositoryUserExtension ( ) const

virtual

virtual void DtVrfObjectParameters::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath = DtFilename::nullFilename(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters.

Reimplemented in DtGroundVehicleParameters.

virtual DtTime DtVrfObjectParameters::underFireTime ( ) const

virtual

Deprecated:

For backwards compatibility only. This value should be specified in the damage actuator's descriptor.

virtual void DtVrfObjectParameters::setUnderFireTime ( DtTime  time )

virtual

Deprecated:

For backwards compatibility only. This value should be specified in the damage actuator's descriptor.

virtual bool DtVrfObjectParameters::underFireTimeSpecified ( ) const

virtual

Deprecated:

For backwards compatibility only. This function allows the damage actuator to know if myUnderFireTime should override the value in its descriptor.

virtual DtReal DtVrfObjectParameters::underFireDistance ( ) const

virtual

Deprecated:

For backwards compatibility only. This value should be specified in the damage actuator's descriptor.

virtual void DtVrfObjectParameters::setUnderFireDistance ( DtReal  underFireDistance )

virtual

Deprecated:

For backwards compatibility only. This value should be specified in the damage actuator's descriptor.

virtual bool DtVrfObjectParameters::underFireDistanceSpecified ( ) const

virtual

Deprecated:

For backwards compatibility only. This function allows the damage actuator to know if myUnderFireDistance should override the value in its descriptor.

virtual const DtSimSector& DtVrfObjectParameters::initialSectorOfResponsibility ( ) const

virtual

See Also

myInitialSectorOfResponsibility

virtual void DtVrfObjectParameters::setInitialSectorOfResponsibility ( const DtSimSector &  sor )

virtual

See Also

myInitialSectorOfResponsibility

virtual DtTaskExecutionRules& DtVrfObjectParameters::taskExecutionRules ( )

virtual

See Also

myTaskExecutionRules

virtual const DtTaskExecutionRules& DtVrfObjectParameters::taskExecutionRules ( ) const

virtual

See Also

myTaskExecutionRules

virtual void DtVrfObjectParameters::setTaskExecutionRulesFilename ( const DtFilename &  )

virtual

See Also

myTaskExecutionRulesFilename

virtual const DtReaderWriterFile& DtVrfObjectParameters::taskExecutionRulesFilename ( ) const

virtual

See Also

myTaskExecutionRulesFilename

virtual const DtAutoConnectionsListPtr& DtVrfObjectParameters::autoConnections ( ) const

virtual

Returns

The list of auto connections

virtual DtAutoConnectionsListPtr& DtVrfObjectParameters::autoConnections ( )

virtual

virtual const std::list<DtSimArtPartDescriptor*>* DtVrfObjectParameters::completeArtPartList ( ) const

virtual

Returns

A list containing all the DtSimArtPartDescriptor instances for all actuators on this entity. This includes art parts that are specified on an actuator that is part of a system, and not directly on the main actuator list.

virtual void DtVrfObjectParameters::connectSystems ( )

virtual

Creates entity-level connections between systems based on sysdef metadata.

bool DtVrfObjectParameters::operator==

(

const DtVrfObjectParameters &

)

const

Equality operator. Simply compares the contents of the registry.

bool DtVrfObjectParameters::operator!=

(

const DtVrfObjectParameters &

)

const

virtual DtEnvironmentSP DtVrfObjectParameters::xmlEnvironment ( )

virtual

virtual DtVrfSubObjectParameterList* DtVrfObjectParameters::createSubordinateObjectsList ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry  ) const

protectedvirtual

Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init().

Override this function if you want to create a derived type. Name is the DtReaderWriter name of the object (the name will appear as the first string in the object when this object is written out to file).

virtual DtVrfSubObjectParameterList* DtVrfObjectParameters::createAttachedObjectsList ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry  ) const

protectedvirtual

Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init().

Override this function if you want to create a derived type. Name is the DtReaderWriter name of the object (the name will appear as the first string in the object when this object is written out to file).

virtual void DtVrfObjectParameters::rebuildArtPartList ( )

protectedvirtual

Clears out and rebuilds myCompleteArtPartList.

Should be called after any point in which the art parts may have changed.

virtual void DtVrfObjectParameters::addArtPartsFromSystem ( DtComponentSystemDescriptor *  systemDesc, std::list< DtSimArtPartDescriptor * > &  artPartList  )

protectedvirtual

Adds any art parts defined within a system to the list.

Recurses if the system contains other systems. Utility function used by rebuildArtPartList().

virtual void DtVrfObjectParameters::createAutomaticConnections ( DtRwAutoConnection *  autoConnection )

protectedvirtual

Member Data Documentation

DtObjectType DtVrfObjectParameters::myMatchType

protected

An extended form of the DIS/RPR FOM entity enumerated type.

Specifies the key used to look up the entry. VR-Forces adds a field to the DIS/RPR FOM entity enumeration so that we can manage objects that are not part of the DIS/RPR enumeration scheme, such as aggregate entities and control objects. We enclose the seven-digit DIS/RPR FOM enumeration in parentheses and preface it with the object super-type.
<super type>=""> (<DIS rpr="" fom="" enumerated="" type>="">)
For example, an M1A2 has the following object type:
1 (1 1 225 1 1 3 0)

See Also

objTypeEnums.h for the list of available super-type values.
For more information about the entity enumeration scheme, see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).

DtObjectType DtVrfObjectParameters::myObjectType

protected

DtRwBoundingGeometryType DtVrfObjectParameters::myBoundingGeometryType

protected

Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).

The value specified affects how the bounding-volume parameter gets interpreted in the code. Values may be:

• Undefined: No bounding geometry information is indicated.
• Area: Only the first 2 rows and columns of a 3x3 matrix used to represent the geometry are used to define the area. Used for 2 dimensional objects such as control areas.
• Volume: A complete 3x3 matrix is used to represent a 3 dimensional bounding box containing the object.

DtRwBoundingVolume DtVrfObjectParameters::myBvol

protected

Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object.

It has the following sub-parameters:

• local-bvol: half-length, half-width, and half-height of the entity (3 real numbers)
• offset: Body coordinate x, y, z offset from entity position

  Note

  body coordinates is x forward, y right, z down)

  bounding-volume is an optional parameter. However, if you specify it, you must specify both local-bvol and offset. Parameter Default Value: local-bvol: <1.0, 1.0, 1.0> offset: <0.0, 0.0, 0.0>

DtVrfObjectSubComponentTypes* DtVrfObjectParameters::myLocalSubComponentTypes

protected

Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects.

DtVrfObjectSubComponentTypes* DtVrfObjectParameters::myRemoteSubComponentTypes

protected

Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects.

DtRwFormationType DtVrfObjectParameters::myFormationType

protected

Parameter Name: formation
Parameter Description: (Optional) One of the following:

• Column
• Line
• Vee
• Wedge
• Assembly
• Other
• UserFormation<n> where n is a digit from 1 to 255 Parameter Default Value: Other

DtRwForceType DtVrfObjectParameters::myForceType

protected

Parameter Name: force-type Parameter Description: The force to which the object belongs.

One of the following:

• ForceOther
• ForceNeutral
• ForceFriendly
• ForceOpposing
• ForceUserDefinedn, where n is a digit from 1 to 255.

  Note

  This parameter is not currently used. Parameter Default Value: ForceOther.

DtRwString DtVrfObjectParameters::myCategory

protected

Parameter Name: category Parameter Description: The category string to use when creating an echelon ID.

The string category item is used to to describe an entity, e.g. "Armor" Bn, or "M1A1" platform. Parameter Default: "c?" Parameter Units: string

DtRwString DtVrfObjectParameters::myEchelonLevel

protected

Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID.

his is a string indicating the echelon level of a military entity, e.g. "platform" or "Bde". Parameter Default: "e?" Parameter Units: string

DtRwBoolean DtVrfObjectParameters::myOrganized

protected

Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID.

If organized it true, this object type will have an entry in the organization hierarchy. Parameter Default Value: False

DtRwReal DtVrfObjectParameters::myMinTickPeriod

protected

Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components.

Parameter Default Value: 0. Parameter Units: seconds

DtRwReal DtVrfObjectParameters::myMinTickPeriodVariance

protected

Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary.

Defined as: plus or minus rand(min-tick-period/2). Parameter Default Value: 0. Parameter Units: seconds

DtRwDeadReckonTypes DtVrfObjectParameters::myDeadReckoningAlgorithm

protected

Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity.

See the IEEE Standard for Distributed Interactive Simulation – Application Protocols for more information on the meaning of these different algorithms. One of:

• Other: Fvw
• Static: Fpb
• Fpw: Rpb
• Rpw: Rvb
• Rvw: Fvb. Parameter Default Value: Fpw

DtRwDeadReckonThresholds DtVrfObjectParameters::myDeadReckoningThresholds

protected

Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity.

Parameter Default Value: 1.0, 3.0, 0.05 (translation, rotation, aggregate-dimension) Parameter Units: meters (translation), degrees (rotation), unitless (aggregate dimension – value between 0 and 1 representing percentage change in extent)

DtRwBoolean DtVrfObjectParameters::myDeadReckoningAllowGuiOverrides

protected

Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).

The value specified affects how the bounding-volume parameter gets interpreted in the code. Values may be:

• Undefined: No bounding geometry information is indicated.
• Area: Only the first 2 rows and columns of a 3x3 matrix used to represent the geometry are used to define the area. Used for 2 dimensional objects such as control areas.
• Volume: A complete 3x3 matrix is used to represent a 3 dimensional bounding box containing the object.

DtRadioDescriptorList DtVrfObjectParameters::myRadioDescriptorList

protected

Parameter Name: radios Parameter Description: List of all radios on the entity.

DtComponentSystemDescriptorList DtVrfObjectParameters::mySystemDescriptorList

protected

Parameter Name: systems Parameter Description: List of system descriptors.

Systems are collections of sensors/controllers/actors to be added as a group to the entity.

DtComponentDescriptorList DtVrfObjectParameters::mySensorDescriptorList

protected

Parameter Name: sensors Parameter Description: List of sensor controller component descriptors.

DtComponentDescriptorList DtVrfObjectParameters::myControllerDescriptorList

protected

Parameter Name: controllers Parameter Description: List of controller component descriptors.

DtComponentDescriptorList DtVrfObjectParameters::myActuatorDescriptorList

protected

Parameter Name: actuators Parameter Description: List of actuator component descriptors.

DtConnectionDescriptorList DtVrfObjectParameters::myConnectionDescriptorList

protected

Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both).

Components attach to each other by connecting output and input ports to one another, or output port groups to input port groups. Since a component can have more than one port, port group, or both, the name of the port or port group to use is also specified. If an entity does not have any components that need to connect to one another, then you can omit this entry. Items in the connections entry can be in one of the following forms:

• Specify a port-to-port connection: connect component_name:output_port component_name:input_port
  
• Specify a port group-to-port group connection: connect component_name:output_port_group component_name:input_port_group The connections in Example 5.2 use this format.
• Specify a port-to-port connection, in which one or both of the ports exists inside of a group, as follows: The input port belongs to an input port group: connect component_name:output_port component_name:input_port_group:input_port The output port belongs to an output port group: connect component_name:output_port group:output_port component_name:input_port Both input and output ports belong to groups: connect component_name:output_port_group:output_port component_name:input_port_group:input_port The port and port group names are defined in code for each component.

DtRwReal DtVrfObjectParameters::myMass

protected

Parameter Name: mass Parameter Description: The mass of the entity.

Parameter Default Value: 5000. Parameter Units: kilograms

DtRwSensorSignatureList DtVrfObjectParameters::mySensorSignatureList

protected

Parameter Name: sensor-signatures Parameter Description: Parameter Default Value:

DtVrfSubObjectParameterList* DtVrfObjectParameters::mySubordinateObjects

protected

Parameter Name: subordinate-objects
Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object.

Each entry specifies a subobject to be created when fully instantiating an aggregate object (as opposed to building such an entity from the bottom up, using aggregateAs). The entry contains an object type, a position offset, and a heading offset (offsets with respect to the parent objects position and heading). Each entry has the following parameters:

• object-type: (Required) Object type of the subordinate to be created. Object type is an extension of the DIS/RPR enumeration.
• position-offset: (Optional) Position offset of subordinate object in body coordinates of the aggregate object at creation time, in meters. Default: < 0.0 0.0 0.0 > (3 real numbers)
• heading-offset: (Optional) Heading offset of the subordinate object with respect to the aggregate's heading at creation time, in radians. Default: 0.0 (real number)
  Example subordinate-objects entry:
  (subordinate-objects
  (sub1
  (object-type 1 (1 1 225 1 1 3 -1))
  (position-offset -20.00000 0.000000 0.00000)
  (heading-offset -0.78)
  )
  (sub2
  (object-type 1 (1 1 225 1 1 3 -1))
  (position-offset -20.00000 8.000000 0.00000)
  (heading-offset 0.78)
  )
  )

DtVrfSubObjectParameterList* DtVrfObjectParameters::myAttachedObjects

protected

Parameter Name: attached-objects
Parameter Description:
Parameter Default Value:
.

DtRwString DtVrfObjectParameters::myEngagementRules

protected

Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message.

Applies to aggregate entities also. Options:

• "hold-fire"
• "fire-when-fired-upon"
• "fire-at-will" Parameter Default: "fire-at-will"

DtSimResourceManager DtVrfObjectParameters::myResourceManager

protected

Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has.

The resources parameter has a list of resource parameters whose name is the name of the resource, and which has the following format:

• resource-type - Currently "integer-resource" or "real-resource" (string)
• full-amount - Specifies what is considered a full load of this resource. (integer or real, based on resource type.)
• amount - The amount of the specified resource available. (integer or real, based on resource type.)
• subresources - Just like a resource; name is the name of the subresource, and all other resource parameters are available.

  Note

  There are no default values for resources. If a resource is expected (such as fuel), and it is not specified, then consumption of that resource is not modeled.
  

DtRwString DtVrfObjectParameters::myStateRepositoryUserExtensionType

protected

Parameter Name: state-repository-extension-type
Parameter Description: Type of state repository extensions class to instantiate.

Users may define derived DtVrfStateRepositoryUserExtension types and register them with the DtVrfStateRepositoryUserExtensionFactory. This is the unique string value that gets registered with that factory.
Parameter Default Value:

DtRwBoolean DtVrfObjectParameters::myTaskedBySuperiorUponTaskComplete

protected

Parameter Name: tasked-by-superior-upon-task-complete
Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task.

Parameter Default Value: True

DtVrfStateRepositoryUserExtension* DtVrfObjectParameters::myStateRepositoryUserExtension

protected

Parameter Name: user-extension
Parameter Description: Extension to the state repository class.

Users may define derived types to extend all state repository objects at the base class level. parameters to
Parameter Default Value:

DtRwTime DtVrfObjectParameters::myUnderFireTime

protected

Parameter Name: under-fire-time
Parameter Description: Deprecated.

This concept is now modeled in the DtUnderFireDeterminationComponentDescriptor.
Parameter Default Value:

DtRwReal DtVrfObjectParameters::myUnderFireDistance

protected

Parameter Name: under-fire-distance
Parameter Description: Deprecated.

This concept is now modeled in the DtUnderFireDeterminationComponentDescriptor.
Parameter Default Value:

DtSimSector DtVrfObjectParameters::myInitialSectorOfResponsibility

protected

Parameter Name: initial-sector-of-responsibility
Parameter Description: The sector of responsibility for this entity when the entity is first created.

This value will be replaced by any Set Sector Of Responsibility commands issued to the entity. Specified as Center and Size angles. Parameter Units: Radians (0 = north). Parameter Default Value: Center 0, Size pi / 2

DtReaderWriterFile DtVrfObjectParameters::myTaskExecutionRulesFilename

protected

Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity.

These rules are used to determine what tasks can be executed concurrently, and what tasks will interrupt other tasks on the entity. Parameter Default Value: None.

DtTaskExecutionRules DtVrfObjectParameters::myTaskExecutionRules

protected

Task execution rules.

This is the structure that is read in from the file pointed to by myTaskExecutionRulesFilename;

DtString DtVrfObjectParameters::myParameterType

protected

String that keeps the type of parameter this is Local only – not part of descriptor.

Referenced by parameterType(), and setParameterType().

DtVrfObjectParameterFactory* DtVrfObjectParameters::theFactory

staticprotected

std::list<DtSimArtPartDescriptor*> DtVrfObjectParameters::myCompleteArtPartList

protected

A list containing all the art part descriptors from actuators directly on the entity and those in systems as well.

Contains pointers to the descriptors, and does not maintain copies of the descriptors.

DtEnvValueSP* DtVrfObjectParameters::myObjectNode

protected

DtEnvironmentSP DtVrfObjectParameters::myEnvironment

protected

DtAutoConnectionsListPtr DtVrfObjectParameters::myAutoConnections

protected

---

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

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