DtAggregateObjectParameters Class Reference

Contains the set of readable/writeable parameters associated with a pseudo-aggregate entities. More...

Inheritance diagram for DtAggregateObjectParameters:

Public Member Functions
	DtAggregateObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtAggregateObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
const DtAggregateObjectParameters &	operator= (const DtAggregateObjectParameters &orig)
virtual	~DtAggregateObjectParameters ()
	destructor
virtual bool	init ()
	Invoked when created so that deriving classes may do virtual allocation as necessary.
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
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 DtString	type () const
	Should return the type of entity this is a parameter block for.
virtual void	inheritValuesFromThisType (const DtAggregateObjectParameters *benefactor)
virtual DtFormation *	getFormation (const DtString &formationName, DtString *retFormationName=NULL) const
	Lookup and return a DtFormation from the formation table for this aggregate.
virtual DtFormation *	getDefaultFormation () const
	Find the default formation in the formation table and return that.
virtual DtFormationTable *	formationTable ()
	Accessor/mutator for myFormationTable.
virtual const DtFormationTable *	formationTable () const
Public Member Functions inherited from DtMovingObjectParameters
	DtMovingObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
	constructor with parameters to set up read/writability correctly
	DtMovingObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
virtual	~DtMovingObjectParameters ()
	destructor
const DtMovingObjectParameters &	operator= (const DtMovingObjectParameters &orig)
	assignment operator
virtual void	inheritValuesFromThisType (const DtMovingObjectParameters *benefactor)
virtual bool	canPivot () const
	Accessor/mutator for myCanPivot.
virtual void	setCanPivot (bool newValue)
	Accessor/mutator for myCanPivot.
virtual DtReal	maxPivotSpeed () const
	Accessor/mutator for myMaxPivotSpeed.
virtual void	setMaxPivotSpeed (DtReal maxSpeed)
	Accessor/mutator for myMaxPivotSpeed.
virtual const DtVector &	leftSupport () const
	Accessor/mutator for myLeftSupport.
virtual void	setLeftSupport (const DtVector &newLeftSupport)
	Accessor/mutator for myLeftSupport.
virtual const DtVector &	rightSupport () const
	Accessor/mutator for myRightSupport.
virtual void	setRightSupport (const DtVector &newRightSupport)
	Accessor/mutator for myRightSupport.
virtual const DtVector &	otherSupport () const
	Accessor/mutator for myOtherSupport.
virtual void	setOtherSupport (const DtVector &newOtherSupport)
	Accessor/mutator for myOtherSupport.
virtual DtReal	maxSpeed () const
	Accessor/mutator for myMaxSpeed.
virtual void	setMaxSpeed (DtReal speed)
	Accessor/mutator for myMaxSpeed.
virtual DtReal	maxReverseSpeed () const
	Accessor/mutator for myMaxReverseSpeed.
virtual void	setMaxReverseSpeed (DtReal speed)
	Accessor/mutator for myMaxReverseSpeed.
virtual DtReal	turningRadius () const
	Accessor/mutator for myTurningRadius.
virtual void	setTurningRadius (DtReal turningRadius)
	Accessor/mutator for myTurningRadius.
virtual DtReal	maxSlope () const
	Accessor/mutator for myMaxSlope.
virtual void	setMaxSlope (DtReal slope)
	Accessor/mutator for myMaxSlope.
virtual DtReal	orderedSpeed () const
	Accessor/mutator for myOrderedSpeed.
virtual void	setOrderedSpeed (DtReal speed)
	Accessor/mutator for myOrderedSpeed.
virtual DtReal	maxAcceleration () const
	Accessor/mutator for myMaxAcceleration.
virtual void	setMaxAcceleration (const DtReal maxAcceleration)
	Accessor/mutator for myMaxAcceleration.
virtual DtReal	maxStoppingDeceleration () const
	Accessor/mutator for myMaxStoppingDeceleration.
virtual void	setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
	Accessor/mutator for myMaxStoppingDeceleration.
virtual DtReal	maxLateralAcceleration () const
	Accessor/mutator for myMaxLateralAcceleration.
virtual void	setMaxLateralAcceleration (const DtReal maxLateralAcceleration)
	Accessor/mutator for myMaxLateralAcceleration.
virtual DtReal	fuelEfficiency () const
	Accessor/mutator for myFuelEfficiency.
virtual void	setFuelEfficiency (const DtReal efficiency)
	Accessor/mutator for myFuelEfficiency.
virtual const DtString &	objectGeometryFile () const
	Accessor/mutator for myObjectGeometryFile.
virtual void	setObjectGeometryFile (const DtFilename &)
	Accessor/mutator for myObjectGeometryFile.
virtual void	setDIGuyCharacterInfo (const DtRwDIGuyCharacterInfo &info)
	Accessor/mutator for #myDIGuyCharacter.
virtual const DtRwDIGuyCharacterInfo &	diGuyCharacterInfo () const
	Accessor/mutator for #myDIGuyCharacter.
virtual void	setMaxDisaggregationDistance (DtReal distance)
	Maximum disaggregation distance in meters.
virtual DtReal	maxDisaggregationDistance () const
	Maximum disaggregation distance in meters.
virtual void	setUsingRailMovement (bool rails)
	Accessor/mutator for myUsingRailMovement.
virtual bool	usingRailMovement () const
	Accessor/mutator for myUsingRailMovement.
Public Member Functions inherited from 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 (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
virtual	~DtVrfObjectParameters ()
	destructor
DtVrfObjectParameters &	operator= (const DtVrfObjectParameters &orig)
	assignment operator
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 *	creator (DtEnvironmentSP env, DtEnvValueSP *objectNode)

Protected Member Functions
	DtAggregateObjectParameters (const DtAggregateObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtAggregateObjectParameters (const DtAggregateObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtFormationTable *	createFormationTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	Factory method for DtFormationTable.
Protected Member Functions inherited from DtMovingObjectParameters
	DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor. Use clone instead...
	DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Member Functions inherited from DtVrfObjectParameters
	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
Parameters
These parameters are available for setting in the OPD files. Parameter Name: formation-list Parameter Description: Table of formation entries indicating positions and offsets each member should maintain in. Parameter Default Value:
DtFormationTable *	myFormationTable
Protected Attributes inherited from DtMovingObjectParameters
DtRwBoolean	myUsingRailMovement
	Parameter Name: using-rail-movement Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving.
DtRwBoolean	myCanPivot
	Parameter Name: can-pivot Parameter Description: Indicates whether not the entity can pivot to turn.
DtRwReal	myMaxPivotSpeed
	Parameter Name: max-pivot-speed Parameter Description: The maximum rate at which a ground entity can turn in place.
DtRwOffsetVector	myLeftSupport
	Parameter Name: left-support Parameter Description: Support contact point in body coordinates.
DtRwOffsetVector	myRightSupport
	Parameter Name: right-support Parameter Description: Support contact point in body coordinates.
DtRwOffsetVector	myOtherSupport
	Parameter Name: other-support Parameter Description: Support contact point in body coordinates.
DtRwReal	myMaxSpeed
	Parameter Name: max-speed Parameter Description: The top speed of the entity.
DtRwReal	myMaxReverseSpeed
	Parameter Name: max-reverse-speed Parameter Description: The maximum speed at which an entity can move in reverse.
DtRwReal	myTurningRadius
	Parameter Name: turning-radius Parameter Description: Minimum turning radius.
DtRwReal	myMaxSlope
	Parameter Name: max-slope Parameter Description: For ground entities, the maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion.
DtRwReal	myOrderedSpeed
	Parameter Name: ordered-speed Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.
DtRwReal	myMaxAcceleration
	Parameter Name: max-acceleration Parameter Description: The maximum acceleration rate for the entity.
DtRwReal	myMaxStoppingDeceleration
	Parameter Name: max-deceleration Parameter Description: The maximum (braking) deceleration for the entity.
DtRwReal	myMaxLateralAcceleration
	Parameter Name: max-lateral-acceleration Parameter Description: The maximum lateral (turning) acceleration for the entity.
DtRwReal	myFuelEfficiency
	Parameter Name: fuel-efficiency Parameter Description: Air and ground entities: the number of meters the entity goes on one liter of fuel.
DtReaderWriterFile	myObjectGeometryFile
	Parameter Name: object-geometry-file Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item.
DtRwDIGuyCharacterInfo	myDIGuyCharacterInfo
	Parameter Name: di-guy-character Parameter Description: DI-Guy representation of the entity if any.
DtRwReal	myDisaggregationRange
	Parameter Name: disaggregation-range Parameter Description: Maximimum distance from this type of entity that will trigger a aggregate to disaggregate.
Protected Attributes inherited from DtVrfObjectParameters
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
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.

Additional Inherited Members
Public Types inherited from DtVrfObjectParameters
typedef DtRwTemplatedListPtr < DtRwAutoConnection >	DtAutoConnectionsListPtr
Static Protected Attributes inherited from DtVrfObjectParameters
static DtVrfObjectParameterFactory *	theFactory

Detailed Description

Contains the set of readable/writeable parameters associated with a pseudo-aggregate entities.

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

Constructor & Destructor Documentation

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

Constructor with parameters to set up read/writability correctly.

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

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

protected

copy constructor

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

protected

virtual DtAggregateObjectParameters::~DtAggregateObjectParameters ( )

virtual

destructor

Member Function Documentation

const DtAggregateObjectParameters& DtAggregateObjectParameters::operator=

(

const DtAggregateObjectParameters &

orig

)

virtual bool DtAggregateObjectParameters::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 from DtVrfObjectParameters.

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

virtual

Reimplemented from DtMovingObjectParameters.

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

virtual

Reimplemented from DtMovingObjectParameters.

virtual bool DtAggregateObjectParameters::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. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual DtString DtAggregateObjectParameters::type ( ) const

virtual

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

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

virtual

virtual DtFormation* DtAggregateObjectParameters::getFormation ( const DtString &  formationName, DtString *  retFormationName = NULL  ) const

virtual

Lookup and return a DtFormation from the formation table for this aggregate.

Pass in return pointer to store the name of the formation actually returned in case the supplied formation name does not exist

virtual DtFormation* DtAggregateObjectParameters::getDefaultFormation ( ) const

virtual

Find the default formation in the formation table and return that.

virtual DtFormationTable* DtAggregateObjectParameters::formationTable ( )

virtual

Accessor/mutator for myFormationTable.

virtual const DtFormationTable* DtAggregateObjectParameters::formationTable ( ) const

virtual

virtual DtFormationTable* DtAggregateObjectParameters::createFormationTable ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

protectedvirtual

Factory method for DtFormationTable.

Returns

Newly allocated instance of DtFormationTable

static DtVrfObjectParameters* DtAggregateObjectParameters::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 from DtMovingObjectParameters.

Member Data Documentation

DtFormationTable* DtAggregateObjectParameters::myFormationTable

protected

---

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

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