VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
DtGlobalEnvironmentStateRepositoryRWData Class Reference
Inheritance diagram for DtGlobalEnvironmentStateRepositoryRWData:
Inheritance graph
[legend]

Public Member Functions

 DtGlobalEnvironmentStateRepositoryRWData (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
 
void setDateAndTimeOfDay (double d)
 
double dateAndTimeOfDay () const
 
bool dateAndTimeOfDaySpecified () const
 
void setTimeOfDayAdvancementSpeed (double d)
 
double timeOfDayAdvancementSpeed () const
 
void setUseDayNightIlluminationModel (bool b)
 
bool useDayNightIlluminationModel () const
 
void setStartTimeIsLocal (bool b)
 
bool startTimeIsLocal () const
 
void setScenarioStartTimeAtLocalOnFirstObjectCreationToTime (int i)
 
int scenarioStartTimeAtLocalOnFirstObjectCreationToTime () const
 
- Public Member Functions inherited from DtWeatherStateRepositoryRWData
 DtWeatherStateRepositoryRWData (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
 
virtual ~DtWeatherStateRepositoryRWData ()
 
virtual void setLightningPresent (bool isPresent)
 
virtual bool lightningPresent () const
 
const DtRwWindLevelswindLevels () const
 
DtRwWindLevelswindLevels ()
 
void resolve () override
 
void setAirTurbidity (double value)
 
double airTurbidity () const
 
void setAmbientAirTemperature (double value)
 
double ambientAirTemperature () const
 
void setAmbientAirPressure (double value)
 
double ambientAirPressure () const
 
void setCloudState (DtVrfWeatherCloudState current)
 
DtVrfWeatherCloudState cloudState () const
 
void setPrecipitationIntensity (double value)
 
double precipitationIntensity () const
 
void setPrecipitationType (DtVrfWeatherPrecipitationType value)
 
DtVrfWeatherPrecipitationType precipitationType () const
 
void setPriority (int value)
 
int priority () const
 
void setUnderwaterVisibility (double value)
 
double underwaterVisibility () const
 
void setSurfaceTransparency (double value)
 
double surfaceTransparency () const
 
void setWaterCurrentSpeed (double value)
 
double waterCurrentSpeed () const
 
void setWaterCurrentDirection (double value)
 
double waterCurrentDirection () const
 
void setAmbientWaterTemperature (double value)
 
double ambientWaterTemperature () const
 
void setTidalOffset (double value)
 
double tidalOffset () const
 
void setTidalDirection (bool value)
 
bool tidalDirection () const
 
void setSwellState (unsigned int value)
 
unsigned int swellState () const
 
void setSwellStateDirection (double value)
 
double swellStateDirection () const
 
void setSeaState (unsigned int value)
 
unsigned int seaState () const
 
void setSeaStateDirection (double value)
 
double seaStateDirection () const
 
void setWindDrivenSeaStateEnabled (bool b)
 
bool windDrivenSeaStateEnabled () const
 
void setChoppiness (double value)
 
double choppiness () const
 
void setSurgeDepth (double value)
 
double surgeDepth () const
 
void setFogHeight (double value)
 
double fogHeight () const
 
void setFogColor (const DtVector &color)
 
const DtVectorfogColor () const
 
virtual void setSnowAccumulation (double snow)
 
virtual double snowAccumulation () const
 
virtual void setRainAccumulation (double snow)
 
virtual double rainAccumulation () const
 
virtual void setSnowMinimumAltitude (double snow)
 
virtual double snowMinimumAltitude () const
 
virtual void setSnowRoadAccumulation (double snow)
 
virtual double snowRoadAccumulation () const
 
virtual void setAirTemperatureAltitude (double value)
 
virtual double airTemperatureAltitude () const
 
virtual void setAirPressureAltitude (double value)
 
virtual double airPressureAltitude () const
 
virtual void setAirTemperatureAltitudeIsSeaLevel (bool value)
 
virtual bool airTemperatureAltitudeIsSeaLevel () const
 
virtual void setAirPressureAltitudeIsSeaLevel (bool value)
 
virtual bool airPressureAltitudeIsSeaLevel () const
 
virtual void setSeaLevelWaterConcentration (double value)
 
virtual double seaLevelWaterConcentration () const
 
void setThermoclineLayer1Depth (double depth)
 
double thermoclineLayer1Depth () const
 
void setThermoclineLayer1Permeability (double depth)
 
double thermoclineLayer1Permeability () const
 
void setThermoclineLayer2Depth (double depth)
 
double thermoclineLayer2Depth () const
 
void setThermoclineLayer2Permeability (double depth)
 
double thermoclineLayer2Permeability () const
 
void setThermoclineLayer3Depth (double depth)
 
double thermoclineLayer3Depth () const
 
void setThermoclineLayer3Permeability (double depth)
 
double thermoclineLayer3Permeability () const
 
void setThermoclineLayer4Depth (double depth)
 
double thermoclineLayer4Depth () const
 
void setThermoclineLayer4Permeability (double depth)
 
double thermoclineLayer4Permeability () const
 
void setThermoclineLayer5Depth (double depth)
 
double thermoclineLayer5Depth () const
 
void setThermoclineLayer5Permeability (double depth)
 
double thermoclineLayer5Permeability () const
 
- Public Member Functions inherited from DtVrfOverlayObjectStateRepositoryRWData
 DtVrfOverlayObjectStateRepositoryRWData (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
 
virtual ~DtVrfOverlayObjectStateRepositoryRWData ()
 
void setPhysicalLineHeight (double d)
 
double physicalLineHeight () const
 
void setPhysicalLineWidth (double d)
 
double physicalLineWidth () const
 
void setUserData (const DtString &s)
 
const DtStringuserData () const
 
void setColor (int c)
 
int color () const
 
- Public Member Functions inherited from DtVrfObjectStateRepositoryRWData
 DtVrfObjectStateRepositoryRWData (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
 
virtual ~DtVrfObjectStateRepositoryRWData ()
 
void initializeFromParameters (const DtVrfObjectParameters *params)
 
DtRwPropertiesstateProperties ()
 
const DtRwPropertiesstateProperties () const
 
DtRwStringAttributeListrwExtendedData ()
 
const DtRwStringAttributeListrwExtendedData () const
 
DtRwIntegerAttributeListrwExtendedLabels ()
 
const DtRwIntegerAttributeListrwExtendedLabels () const
 
void setIsDestroyed (bool b)
 
bool isDestroyed () const
 
bool isSubordinateOfForceLevel () const
 
void setIsSubordinateOfForceLevel (bool b)
 
bool independentlyTasked () const
 
void setIndependentlyTasked (bool b)
 
const DtUUIDparent () const
 
void setParent (const DtUUID &p)
 
void setAppearance (const DtAppearance &a)
 
const DtAppearance & appearance () const
 
void setCapabilities (unsigned int c)
 
unsigned int capabilities () const
 
void setForceType (DtForceType c)
 
DtForceType forceType () const
 
void setDesignator (int i)
 
int designator () const
 
void setEngagementRules (const DtString &s)
 
const DtStringengagementRules () const
 
void setStationName (DtStationName name)
 
DtStationName stationName () const
 
- Public Member Functions inherited from DtLegacySimObjectStateRepositoryRWData
 DtLegacySimObjectStateRepositoryRWData (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
 
void setAttachedToRepository (const DtRwUUID &ot)
 
const DtRwUUIDattachedToRepository () const
 
const
makVrf::DtRwVrfKinematicState
kinematicState () const
 
makVrf::DtRwVrfKinematicStatekinematicState ()
 
const makVrf::DtVrfObjectGeometryobjectGeometry () const
 
makVrf::DtVrfObjectGeometryobjectGeometry ()
 
const
makVrf::DtArticulatedPartManager
articulatedParts () const
 
makVrf::DtArticulatedPartManagerarticulatedParts ()
 
const DtStringobjectLabel () const
 
void setObjectLabel (const DtString &l)
 
const DtStringoverlay () const
 
void setOverlay (const DtString &l)
 
- Public Member Functions inherited from DtScopedReaderWriter
 DtScopedReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry)
 
virtual ~DtScopedReaderWriter ()
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool wasUpdatedSince (DtTime t) const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
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())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Protected Attributes

parameters

These parameters are available for setting in the physicalWorldParams.

DtRwReal myTimeOfDay
 
DtRwReal myTimeOfDayAdvancementSpeed
 
DtRwBoolean myUseDayNightIlluminationModel
 
DtRwInt mySetScenarioStartTimeAtLocalOnFirstObjectCreationToTime
 
DtRwBoolean myStartTimeIsLocal
 
- Protected Attributes inherited from DtWeatherStateRepositoryRWData
DtRwReal myAirTurbidity
 
DtRwReal myAmbientAirTemperature
 
DtRwReal myAirTemperatureAltitude
 
DtRwReal myAirPressureAltitude
 
DtRwBoolean myAirTemperatureAltitudeIsSeaLevel
 
DtRwBoolean myAirPressureAltitudeIsSeaLevel
 
DtRwReal mySeaLevelWaterConcentration
 
DtRwReal myAmbientAirPressure
 
DtRwInt myCloudState
 
DtRwReal myPrecipitationIntensity
 
DtRwInt myPrecipitationType
 
DtRwReal myWindSpeed
 
DtRwReal myWindDirection
 
DtRwInt myPriority
 
DtRwReal myVisibility
 
DtRwReal myUnderwaterVisibility
 
DtRwReal mySurfaceTransparency
 
DtRwReal myWaterCurrentSpeed
 
DtRwReal myWaterCurrentDirection
 
DtRwReal myAmbientWaterTemperature
 
DtRwReal myTidalOffset
 
DtRwBoolean myTidalDirection
 
DtRwInt mySwellState
 
DtRwReal mySwellStateDirection
 
DtRwInt mySeaState
 
DtRwReal mySeaStateDirection
 
DtRwBoolean myWindDrivenSeaStateEnabled
 
DtRwReal myChoppiness
 
DtRwReal mySurgeDepth
 
DtRwReal myFogHeight
 
DtRwVector myFogColor
 
DtRwReal mySnowAccumulation
 
DtRwReal myRainAccumulation
 
DtRwReal mySnowMinimumAltitude
 
DtRwReal mySnowRoadAccumulation
 
DtRwReal myThermoclineLayer1Depth
 
DtRwReal myThermoclineLayer1Permeability
 
DtRwReal myThermoclineLayer2Depth
 
DtRwReal myThermoclineLayer2Permeability
 
DtRwReal myThermoclineLayer3Depth
 
DtRwReal myThermoclineLayer3Permeability
 
DtRwReal myThermoclineLayer4Depth
 
DtRwReal myThermoclineLayer4Permeability
 
DtRwReal myThermoclineLayer5Depth
 
DtRwReal myThermoclineLayer5Permeability
 
DtRwBoolean myLightningPresent
 
DtRwWindLevels myWindLevels
 
- Protected Attributes inherited from DtVrfOverlayObjectStateRepositoryRWData
DtRwInt myColor
 
DtRwReal myPhysicalLineHeight
 
DtRwReal myPhysicalLineWidth
 
DtRwString myUserData
 
- Protected Attributes inherited from DtVrfObjectStateRepositoryRWData
DtRwStringAttributeList myRwExtendedData
 
DtRwAppearance myAppearance
 
DtRwInt myCapabilities
 
DtRwForceType myForceType
 
DtRwProperties myStateProperties
 
DtRwBoolean myIndependentlyTasked
 
DtRwBoolean myIsDestroyedFlag
 
DtRwBoolean mySensorsKilled
 
DtRwBoolean myIsSubordinateOfForceLevel
 
DtRwIntegerAttributeList myExtendedLabels
 
DtRwUUID myParent
 
DtRwInt myDesignator
 
DtRwString myEngagementRules
 
DtRwInt myStationName
 
- Protected Attributes inherited from DtLegacySimObjectStateRepositoryRWData
DtRwUUID myAttachedToRepositoryUUID
 
makVrf::DtRwVrfKinematicState myKinematicState
 
makVrf::DtVrfObjectGeometry myObjectGeometry
 
DtRwString myObjectLabel
 
DtRwString myOverlay
 
makVrf::DtArticulatedPartManager myArticulatedParts
 
- Protected Attributes inherited from DtScopedReaderWriter
std::set< DtReaderWriter * > myCurrentRegistryItems
 
DtReaderWriterRegistrymyParentRegistry
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtGlobalEnvironmentStateRepositoryRWData::DtGlobalEnvironmentStateRepositoryRWData ( const DtString rwName,
DtReaderWriterRegistry parentRegistry 
)
inline

Member Function Documentation

void DtGlobalEnvironmentStateRepositoryRWData::setDateAndTimeOfDay ( double  d)
inline
double DtGlobalEnvironmentStateRepositoryRWData::dateAndTimeOfDay ( ) const
inline
bool DtGlobalEnvironmentStateRepositoryRWData::dateAndTimeOfDaySpecified ( ) const
inline
void DtGlobalEnvironmentStateRepositoryRWData::setTimeOfDayAdvancementSpeed ( double  d)
inline
double DtGlobalEnvironmentStateRepositoryRWData::timeOfDayAdvancementSpeed ( ) const
inline
void DtGlobalEnvironmentStateRepositoryRWData::setUseDayNightIlluminationModel ( bool  b)
inline
bool DtGlobalEnvironmentStateRepositoryRWData::useDayNightIlluminationModel ( ) const
inline
void DtGlobalEnvironmentStateRepositoryRWData::setStartTimeIsLocal ( bool  b)
inline
bool DtGlobalEnvironmentStateRepositoryRWData::startTimeIsLocal ( ) const
inline
void DtGlobalEnvironmentStateRepositoryRWData::setScenarioStartTimeAtLocalOnFirstObjectCreationToTime ( int  i)
inline
int DtGlobalEnvironmentStateRepositoryRWData::scenarioStartTimeAtLocalOnFirstObjectCreationToTime ( ) const
inline

Member Data Documentation

DtRwReal DtGlobalEnvironmentStateRepositoryRWData::myTimeOfDay
protected

Numerical representation in seconds from midnight which is 0.

DtRwReal DtGlobalEnvironmentStateRepositoryRWData::myTimeOfDayAdvancementSpeed
protected

Parameter Name: time-of-day-advancement-speed
Parameter Description: Indicates the rate that time of day is advancing.
Default Value: 1.0 Units: time of day seconds per sim time seconds.

DtRwBoolean DtGlobalEnvironmentStateRepositoryRWData::myUseDayNightIlluminationModel
protected

Parameter Name: use-day-night-illumination-model
Parameter Description: If false always use longitude 0 for sunrise/sunset rather.
than entity position
Default Value: true.

DtRwInt DtGlobalEnvironmentStateRepositoryRWData::mySetScenarioStartTimeAtLocalOnFirstObjectCreationToTime
protected

Parameter Name: set-scenario-start-time-at-local-on-first-object-creation-time
Parameter Description: Time to set to (at todays date) if setting time on first object creation Default Value: 36000.

DtRwBoolean DtGlobalEnvironmentStateRepositoryRWData::myStartTimeIsLocal
protected

Whether or not on first placement the start time is in local time or utc time.


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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)