 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates. More...
Public Member Functions | |
| 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 DtVrfObjectParameters * | clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtVrfObjectParameters * | clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtString | type () const |
| Should return the type of object this is a parameter block for. | |
| 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 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 bool | init () |
| Invoked when created so that deriving classes may do virtual allocation as necessary. | |
| 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) |
| | |
| Static Public Member Functions inherited from DtVrfObjectParameters | |
| 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 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 | |
| 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 | |
| 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. | |
parameters | |
These parameters are available for setting in the OPD files. {@ | |
| 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 |
The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates.
Parameters include support points, maximum speed, maximum reverse speed, turning radius, maximum slope, ordered speed, maximum acceleration, maximum deceleration, and fuel efficiency. Aggregates are moving objects and have this parameter type. All of the platform-specific parameter types derive from this one.
| 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::DtMovingObjectParameters | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| DtEnvironmentSP | env = DtEnvironmentSP(), |
||
| DtEnvValueSP * | objectNode = NULL |
||
| ) |
|
virtual |
destructor
|
protected |
copy constructor. Use clone instead...
|
protected |
| const DtMovingObjectParameters& DtMovingObjectParameters::operator= | ( | const DtMovingObjectParameters & | orig | ) |
assignment operator
|
virtual |
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtGroundVehicleParameters, DtHumanParameters, DtCulturalFeatureParameters, DtIndividualLifeFormParameters, DtSubSurfaceEntityParameters, DtSurfaceEntityParameters, DtSpaceEntityParameters, DtMissileParameters, DtBombParameters, and DtScriptedMovementObjectParameters.
|
virtual |
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtRotaryWingEntityParameters, DtSurfaceEntityParameters, DtHumanParameters, DtMissileParameters, DtBombParameters, DtScriptedMovementObjectParameters, and DtSubSurfaceEntityParameters.
|
virtual |
Should return the type of object this is a parameter block for.
Use the strings in vrfParamTypes.h.
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtMissileParameters, DtFixedWingEntityParameters, DtGroundVehicleParameters, DtBombParameters, DtAggregateObjectParameters, DtCulturalFeatureParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtIndividualLifeFormParameters, DtSurfaceEntityParameters, DtScriptedMovementObjectParameters, DtSubSurfaceEntityParameters, and DtSpaceEntityParameters.
|
static |
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtRotaryWingEntityParameters, DtMissileParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtBombParameters, DtCulturalFeatureParameters, DtHumanParameters, DtScriptedMovementObjectParameters, DtSpaceEntityParameters, DtIndividualLifeFormParameters, DtSubSurfaceEntityParameters, and DtSurfaceEntityParameters.
|
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 DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtIndividualLifeFormParameters, DtGroundVehicleParameters, DtSurfaceEntityParameters, DtCulturalFeatureParameters, DtSubSurfaceEntityParameters, DtBombParameters, DtMissileParameters, and DtScriptedMovementObjectParameters.
|
virtual |
|
virtual |
Accessor/mutator for myCanPivot.
|
virtual |
Accessor/mutator for myCanPivot.
|
virtual |
Accessor/mutator for myMaxPivotSpeed.
|
virtual |
Accessor/mutator for myMaxPivotSpeed.
|
virtual |
Accessor/mutator for myLeftSupport.
|
virtual |
Accessor/mutator for myLeftSupport.
|
virtual |
Accessor/mutator for myRightSupport.
|
virtual |
Accessor/mutator for myRightSupport.
|
virtual |
Accessor/mutator for myOtherSupport.
|
virtual |
Accessor/mutator for myOtherSupport.
|
virtual |
Accessor/mutator for myMaxSpeed.
|
virtual |
Accessor/mutator for myMaxSpeed.
|
virtual |
Accessor/mutator for myMaxReverseSpeed.
|
virtual |
Accessor/mutator for myMaxReverseSpeed.
|
virtual |
Accessor/mutator for myTurningRadius.
|
virtual |
Accessor/mutator for myTurningRadius.
|
virtual |
Accessor/mutator for myMaxSlope.
|
virtual |
Accessor/mutator for myMaxSlope.
|
virtual |
Accessor/mutator for myOrderedSpeed.
|
virtual |
Accessor/mutator for myOrderedSpeed.
|
virtual |
Accessor/mutator for myMaxAcceleration.
|
virtual |
Accessor/mutator for myMaxAcceleration.
|
virtual |
Accessor/mutator for myMaxStoppingDeceleration.
|
virtual |
Accessor/mutator for myMaxStoppingDeceleration.
|
virtual |
Accessor/mutator for myMaxLateralAcceleration.
|
virtual |
Accessor/mutator for myMaxLateralAcceleration.
|
virtual |
Accessor/mutator for myFuelEfficiency.
|
virtual |
Accessor/mutator for myFuelEfficiency.
|
virtual |
Accessor/mutator for myObjectGeometryFile.
|
virtual |
Accessor/mutator for myObjectGeometryFile.
|
virtual |
Accessor/mutator for #myDIGuyCharacter.
|
virtual |
Accessor/mutator for #myDIGuyCharacter.
|
virtual |
Maximum disaggregation distance in meters.
|
virtual |
Maximum disaggregation distance in meters.
|
virtual |
Accessor/mutator for myUsingRailMovement.
|
virtual |
Accessor/mutator for myUsingRailMovement.
|
protected |
Parameter Name: can-pivot
Parameter Description: Indicates whether not the entity can pivot to turn.
Parameter Default: False
|
protected |
Parameter Name: max-pivot-speed
Parameter Description: The maximum rate at which a ground entity can turn in place.
Parameter Default Value: 0.
Parameter Units: meters/second
|
protected |
Parameter Name: left-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: right-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: other-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: max-speed
Parameter Description: The top speed of the entity.
Parameter Default Value: 15.
Parameter Units: meters/second
|
protected |
Parameter Name: max-reverse-speed
Parameter Description: The maximum speed at which an entity can move in reverse.
Parameter Default Value: 10.
Parameter Units: meters/second
|
protected |
Parameter Name: turning-radius
Parameter Description: Minimum turning radius.
This will be used differently by different movement models, and does not apply to all of them (such as missiles). Used by non-pivoting ground vehicles; used by surface and subsurface entities for low-speed turns (at high speed, lateral acceleration limits minimum turn radius).
Parameter Default Value: 5.
Parameter Units: meters
|
protected |
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.
Therefore, if a ground vehicle is heading up a hill, as soon as the slope of the hill is greater than the max-slope, it will no longer be able to accelerate up the slope. At best, without any friction or other source of negative acceleration, it will remain at its current speed. If the slope increases, it will start decelerating and even start rolling backwards. If the entity is moving down a hill, the opposite is true.
For subsurface entities, this is the maximum pitch that they will adopt in the simple actuator model when ascending or descending.
Parameter Default Value: 1. Parameter Units: radians
|
protected |
Parameter Name: ordered-speed
Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.
Parameter Default Value: 10.
Parameter Units: meters/second
|
protected |
Parameter Name: max-acceleration
Parameter Description: The maximum acceleration rate for the entity.
Parameter Default Value: 4.5
Parameter Units: meters/second/second
|
protected |
Parameter Name: max-deceleration
Parameter Description: The maximum (braking) deceleration for the entity.
Parameter Default Value: 4.5
Parameter Units: meters/second/second
|
protected |
Parameter Name: max-lateral-acceleration
Parameter Description: The maximum lateral (turning) acceleration for the entity.
Parameter Default Value: 9.8
Parameter Units: meters/second/second
|
protected |
Parameter Name: fuel-efficiency
Parameter Description: Air and ground entities: the number of meters the entity goes on one liter of fuel.
Surface and subsurface entities: The speed, in m/s, that is specified corresponding to the fuel range specified in the movement system. E.g. if a ship range is specified as 1000km at 8 m/s, then the fuel efficiency parameter value is 8.0 (and the fuel range is 1000). A value of 0 indicates we are not modeling fuel consumption (i.e. we will never run out of fuel).
Parameter Default Value: 1000.
Parameter Units: meters/liter
|
protected |
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.
If this item is not defined (or cannot be loaded) then entities cannot be tasked once embarked on this item.
Parameter Default Value:
|
protected |
Parameter Name: di-guy-character
Parameter Description: DI-Guy representation of the entity if any.
Set the DI Guy Character, it's default appearance and animation
Parameter Default Value:
|
protected |
Parameter Name: disaggregation-range
Parameter Description: Maximimum distance from this type of entity that will trigger a aggregate to disaggregate.
Parameter Units: meters Parameter Default Value: 1000.0
|
protected |
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.
If no segments are available to follow will default to regular movement system. Parameter Units: Parameter Default Value: false