VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtSurfaceEntityParameters Class Reference
Inheritance diagram for DtSurfaceEntityParameters:
Inheritance graph
[legend]

Public Member Functions

 DtSurfaceEntityParameters (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
 constructor with parameters to set up read/writability correctly
const DtSurfaceEntityParametersoperator= (const DtSurfaceEntityParameters &orig)
virtual ~DtSurfaceEntityParameters ()
 destructor
virtual DtVrfObjectParametersclone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtVrfObjectParametersclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString type () const
 Should return the type of entity 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 setDefaults ()
 Sets all the default values specified below.
- 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 DtMovingObjectParametersoperator= (const DtMovingObjectParameters &orig)
 assignment operator
virtual void inheritValuesFromThisType (const DtMovingObjectParameters *benefactor)
virtual int illuminationRecalcTime () const
 Accessor/mutator for myIlluminationRecalcTime.
virtual void setIlluminationRecalcTime (int newValue)
 Accessor/mutator for myIlluminationRecalcTime.
virtual int weatherAreaRecalcTime () const
 Accessor/mutator for myWeatherAreaRecalcTime.
virtual void setWeatherAreaRecalcTime (int newValue)
 Accessor/mutator for myWeatherAreaRecalcTime.
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 DtVectorleftSupport () const
 Accessor/mutator for myLeftSupport.
virtual void setLeftSupport (const DtVector &newLeftSupport)
 Accessor/mutator for myLeftSupport.
virtual const DtVectorrightSupport () const
 Accessor/mutator for myRightSupport.
virtual void setRightSupport (const DtVector &newRightSupport)
 Accessor/mutator for myRightSupport.
virtual const DtVectorotherSupport () 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 bool useObjectGeometry () const
 Accessor/mutator for #myUseGeometryFile.
virtual void setUseObjectGeometry (bool)
 Accessor/mutator for #myUseGeometryFile.
virtual const DtStringobjectGeometryFile () 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
DtVrfObjectParametersoperator= (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 DtStringcategory () 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 DtStringechelonLevel () 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 DtComponentDescriptorListsensorDescriptorList ()
virtual void setSensorDescriptorList (const DtComponentDescriptorList &list)
virtual const
DtComponentDescriptorList
controllerDescriptorList () const
 Accessor/mutator for myControllerDescriptorList.
virtual DtComponentDescriptorListcontrollerDescriptorList ()
virtual void setControllerDescriptorList (const DtComponentDescriptorList &list)
virtual const
DtComponentDescriptorList
actuatorDescriptorList () const
 Accessor/mutator for myActuatorDescriptorList.
virtual DtComponentDescriptorListactuatorDescriptorList ()
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
DtRwNavigationParameters
navigationParameters () const
 Accessor/mutator for myNavigationParameters.
virtual DtRwNavigationParametersnavigationParameters ()
virtual void setNavigationParameters (const DtRwNavigationParameters &parameters)
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 DtRwSensorSignatureListsensorSignatureList ()
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 DtReaderWriter::SearchPaths &searchPaths, 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 DtU32 appearance () const
 Accessor/mutator for myDefaultAppearance.
virtual void setAppearance (const DtU32 appearance)
virtual bool appearanceSpecified () const
virtual const DtStringdisplayName () const
 Accessor/mutator for myDisplayName.
virtual void setDisplayName (const DtString &s)
virtual const DtStringdisplayDescription () const
 Accessor/mutator for myDisplayDescription.
virtual void setDisplayDescription (const DtString &s)
virtual const DtStringengagementRules () 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 DtStringstateRepositoryUserExtensionType () 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)
virtual void setRangeRingPublisherTickTime (double)
 Tick time for range ring publisher in simulation seconds. Default is -1 (as fast as possible)
virtual double rangeRingPublisherTickTime () const
void setParameterType (const DtString &)
 Sets/gets type of parameter.
const DtStringparameterType () 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 DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), 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 DtAutoConnectionsListPtrautoConnections ()
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 DtEnvValueSP objectNode ()
virtual const DtReaderWriterfindVariableBinding (const DtString &) const
 Find a variable binding from the original items in getSelf. Only valid if getSelf was called for this object.
virtual const
DtVariableBindingsList
variableBindingsFromLoad () const
virtual
DtReaderWriterRegistryData
findProperty (const DtString &rwName) const
 Returns a property value as defined in the registry (first look) or the additional parameter data (second look)
virtual const DtRwPropertiesparameterData () const
 Return parameter data accessor.
virtual DtRwPropertiesparameterData ()
virtual const DtRwPropertiesstateData () const
 Return state data.
virtual DtRwPropertiesstateData ()
virtual void setPublishParameterData (bool)
 Set to true if the parameter data is to be published in the extended data portion of the object.
virtual bool publishParameterData () const
virtual void setUiFilename (const DtString &uiFilename)
virtual DtString uiFilename () const
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 DtRadioDescriptorListradioDescriptorList ()
 See myRadioDescriptorList.
virtual const DtSimSectorinitialSectorOfResponsibility () const
virtual void setInitialSectorOfResponsibility (const DtSimSector &sor)
virtual DtTaskExecutionRulestaskExecutionRules ()
virtual const
DtTaskExecutionRules
taskExecutionRules () const
virtual void setTaskExecutionRulesFilename (const DtFilename &)
virtual const DtReaderWriterFiletaskExecutionRulesFilename () 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)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (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 postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
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 void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
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 bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
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 void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static DtVrfObjectParameterscreator (DtEnvironmentSP env, DtEnvValueSP *objectNode)
 

Protected Member Functions

 DtSurfaceEntityParameters (const DtSurfaceEntityParameters &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
- 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.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Additional Inherited Members

- Public Types inherited from DtVrfObjectParameters
typedef DtRwTemplatedListPtr
< DtRwAutoConnection, true > 
DtAutoConnectionsListPtr
- 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.
DtRwInt myIlluminationRecalcTime
 Parameter Name: illumination-recalc-time
Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 300 (5 minutes)
DtRwInt myWeatherAreaRecalcTime
 Parameter Name: weather-area-recalc-time
Parameter Description: Amount of time (in seconds) to recalculate if an entity is in a new weather area.
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.
DtRwBoolean myUseObjectGeometry
 Parameter Name: use-object-geometry
Parameter Description: If specified use the geometry file for navigation data, embarkation and line of sight.
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.
- Static Protected Attributes inherited from DtVrfObjectParameters
static
DtVrfObjectParameterFactory
theFactory

Constructor & Destructor Documentation

DtSurfaceEntityParameters::DtSurfaceEntityParameters ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)

constructor with parameters to set up read/writability correctly

DtSurfaceEntityParameters::DtSurfaceEntityParameters ( const DtSurfaceEntityParameters orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
protected

copy constructor

virtual DtSurfaceEntityParameters::~DtSurfaceEntityParameters ( )
virtual

destructor

Member Function Documentation

static DtVrfObjectParameters* DtSurfaceEntityParameters::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.

Reimplemented in DtSubSurfaceEntityParameters.

const DtSurfaceEntityParameters& DtSurfaceEntityParameters::operator= ( const DtSurfaceEntityParameters orig)
virtual DtVrfObjectParameters* DtSurfaceEntityParameters::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubSurfaceEntityParameters.

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

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubSurfaceEntityParameters.

virtual DtString DtSurfaceEntityParameters::type ( ) const
virtual

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

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubSurfaceEntityParameters.

virtual bool DtSurfaceEntityParameters::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.

Reimplemented in DtSubSurfaceEntityParameters.

virtual void DtSurfaceEntityParameters::setDefaults ( )
virtual

Sets all the default values specified below.


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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)