VR-Link API Documentation for HLA 1516
 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 Attributes
DtLandSurfaceStateRepository Class Reference

Instances of DtLandSurfaceStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather.LandSurface objects. More...

+ Inheritance diagram for DtLandSurfaceStateRepository:
+ Collaboration diagram for DtLandSurfaceStateRepository:

Public Member Functions

 DtLandSurfaceStateRepository ()
 Constructor. More...
 
virtual ~DtLandSurfaceStateRepository ()
 Destructor. More...
 
 DtLandSurfaceStateRepository (const DtLandSurfaceStateRepository &orig)
 Copy Constructor. More...
 
DtLandSurfaceStateRepositoryoperator= (const DtLandSurfaceStateRepository &orig)
 Assignment Operator. More...
 
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this. More...
 
virtual void printData () const
 Print data to the DtInfo stream. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print data to the specified stream. More...
 
virtual void setSnow (const DtSnowStruct &ss)
 Set the Snow. More...
 
virtual const DtSnowStructsnow () const
 Get the Snow. More...
 
virtual void setMoisture (const DtSurfaceMoistureEnum16 &moisture)
 Set the Moisture. More...
 
virtual const
DtSurfaceMoistureEnum16
moisture () const
 Get the Moisture. More...
 
virtual void setIceCondition (const DtRoadIceConditionEnum16 &val)
 Set the IceCondition. More...
 
virtual const
DtRoadIceConditionEnum16
iceCondition () const
 Get the IceCondition. More...
 
virtual void setBlowingParticulateMatter (const DtBlowingParticulateMatterEnum16 &val)
 Set the Blowing Particulate Matter. More...
 
virtual const
DtBlowingParticulateMatterEnum16
blowingParticulateMatter () const
 Get the Blowing Particulate Matter. More...
 
virtual const void setPriority (const DtU16 &val)
 Set the priority level. Used when METOC objects overlap. More...
 
virtual const DtU16priority () const
 Get the Priority. More...
 
virtual void setSnowMinimumAltitude (const DtFloat64 &val)
 Set the SnowMinimumAltitude. More...
 
virtual const DtFloat64snowMinimumAltitude () const
 Get the SnowMinimumAltitude. More...
 
virtual void setSnowRoadAccumulation (const DtFloat64 &val)
 Set the SnowRoadAccumulation. More...
 
virtual const DtFloat64snowRoadAccumulation () const
 Get the SnowRoadAccumulation. More...
 
virtual void setReferenceTemperatureAltitude (DtFloat32 val)
 Set the reference altitude for temperature. More...
 
virtual DtFloat32 referenceTemperatureAltitude () const
 Get the reference altitude for temperature. More...
 
virtual void setReferencePressureAltitude (DtFloat32 val)
 Set the reference altitude for pressure. More...
 
virtual DtFloat32 referencePressureAltitude () const
 Get the reference altitude for pressure. More...
 
virtual void setIsLightningPresent (bool val)
 Set if lightning is present in this weather area. More...
 
virtual bool isLightningPresent () const
 Get if lightning is present in this weather area. More...
 
virtual void setRainAccumulation (DtFloat32 val)
 Set the rain accumulation on this land surface in meters. More...
 
virtual DtFloat32 rainAccumulation () const
 Get the rain accumulation on this land surface in meters. More...
 
virtual void setVisualObscurantColor (int r, int g, int b, int a)
 Set the visual obscurant color (R, G, B, A) More...
 
virtual void setVisualObscurantColor (unsigned int color)
 Set the visual obscurant color with an encoded integer value. More...
 
virtual unsigned int visualObscurantColor () const
 Get the encoded integer value of the visual obscurant color. More...
 
virtual void setVisualObscurantHeight (DtFloat32 val)
 Set the height of the visual obscurant affect. More...
 
virtual DtFloat32 visualObscurantHeight () const
 Get the height of the visual obscurant affect. More...
 
- Public Member Functions inherited from DtWeatherStateRepository
 DtWeatherStateRepository ()
 Constructor. More...
 
virtual ~DtWeatherStateRepository ()
 Destructor. More...
 
 DtWeatherStateRepository (const DtWeatherStateRepository &orig)
 Copy Constructor. More...
 
DtWeatherStateRepositoryoperator= (const DtWeatherStateRepository &orig)
 Assignment Operator. More...
 
virtual void setTemperature (DtFloat32 val)
 Set the Temperature. More...
 
virtual DtFloat32 temperature () const
 Get the Temperature.". More...
 
virtual void setWind (const DtWindStruct &val)
 Set the Wind. More...
 
virtual const DtWindStructwind () const
 Get the Wind.". More...
 
virtual void setPrecipitation (const DtPrecipitationStruct &val)
 Set the Precipitation. More...
 
virtual const
DtPrecipitationStruct
precipitation () const
 Get the Precipitation.". More...
 
virtual void setHaze (const DtHazeStruct &val)
 Set the Haze. More...
 
virtual const DtHazeStructhaze () const
 Get the Haze.". More...
 
virtual void setHumidity (DtFloat32 val)
 Set the Humidity. More...
 
virtual DtFloat32 humidity () const
 Get the Humidity.". More...
 
virtual void setBarometricPressure (DtFloat32 val)
 Set the BarometricPressure. More...
 
virtual DtFloat32 barometricPressure () const
 Get the BarometricPressure.". More...
 
virtual void setVisibilityRange (DtFloat32 val)
 Set the VisibilityRange. More...
 
virtual DtFloat32 visibilityRange () const
 Get the VisibilityRange. More...
 
- Public Member Functions inherited from DtEnvironmentConditionStateRepository
 DtEnvironmentConditionStateRepository ()
 Constructor. More...
 
virtual ~DtEnvironmentConditionStateRepository ()
 Destructor. More...
 
 DtEnvironmentConditionStateRepository (const DtEnvironmentConditionStateRepository &orig)
 Copy Constructor. More...
 
DtEnvironmentConditionStateRepositoryoperator= (const DtEnvironmentConditionStateRepository &orig)
 Assignment Operator. More...
 
virtual void setServiceId (const DtVrlUuid &val)
 Set the ServiceId. More...
 
virtual const DtVrlUuidserviceId () const
 Get the ServiceId. More...
 
virtual void setGeoReference (const DtGeoReferenceVariant &val)
 Set the GeoReference. More...
 
virtual const
DtGeoReferenceVariant
geoReference () const
 Get the GeoReference. More...
 
virtual bool isGlobalGeoreference () const
 returns true if the geo reference object is global. More...
 
virtual void setIsMakMetocObject (bool val)
 Set if this object is a MAK extended class. More...
 
virtual bool isMakMetocObject () const
 returns true if this object is a MAK Extended METOC object opposed to a NETN METOC object without MAK extensions More...
 
- Public Member Functions inherited from DtMetocRootStateRepository
 DtMetocRootStateRepository ()
 Constructor. More...
 
virtual ~DtMetocRootStateRepository ()
 Destructor. More...
 
 DtMetocRootStateRepository (const DtMetocRootStateRepository &orig)
 Copy Constructor. More...
 
DtMetocRootStateRepositoryoperator= (const DtMetocRootStateRepository &orig)
 Assignment Operator. More...
 
virtual void setUniqueId (const DtVrlUuid &val)
 Set the UniqueId. More...
 
virtual const DtVrlUuiduniqueId () const
 Get the UniqueId. More...
 
virtual void setName (const DtString &val)
 Set the Name. More...
 
virtual const DtStringname () const
 Get the Name. More...
 
virtual void setVrfWeatherAreaIdentifier (const DtVrlUuid &vrfWeatherAreaIdentifier)
 Set the UniqueId. More...
 
virtual DtVrlUuid vrfWeatherAreaIdentifier () const
 Get the UniqueId. More...
 
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor More...
 
 DtStateRepository (const DtStateRepository &orig)
 copy constructor More...
 
virtual ~DtStateRepository ()
 destructor More...
 
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator More...
 
virtual void setGlobalId (const DtString &id)
 Get/Set global identifier, or name. More...
 
virtual const DtStringglobalId () const
 
virtual void setLocalId (const DtObjectId &id)
 Get/Set local identifier, or handle. More...
 
virtual const DtObjectIdlocalId () const
 
virtual bool publishesAttribute (const RTI::AttributeHandle &val) const
 Returns true if the attribute is published. More...
 
virtual void setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
 Set the attribute with the given handle. More...
 
virtual const char * getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle. More...
 
virtual void setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
 Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject. More...
 
virtual const char * getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
 Get a pointer to attribute value for the attribute with the given name. More...
 
virtual const char * getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it. More...
 
virtual
DtStateRepositoryExtension
stateRepositoryExtension (DtString srExtName) const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual std::vector< DtStringstateRepositoryExtensionNames () const
 Returns a set of the registered state repository extension names. More...
 
virtual void setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual const std::map
< DtString,
DtStateRepositoryExtension * > 
stateRepositoryExtensions () const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 

Static Public Member Functions

static
DtLandSurfaceStateRepository
create ()
 Create a DtLandSurfaceStateRepository. More...
 
- Static Public Member Functions inherited from DtWeatherStateRepository
static DtWeatherStateRepositorycreate ()
 Create a DtWeatherStateRepository. More...
 
- Static Public Member Functions inherited from DtEnvironmentConditionStateRepository
static
DtEnvironmentConditionStateRepository
create ()
 Create a DtEnvironmentConditionStateRepository. More...
 
- Static Public Member Functions inherited from DtMetocRootStateRepository
static DtMetocRootStateRepositorycreate ()
 Create a DtMetocRootStateRepository. More...
 
- Static Public Member Functions inherited from DtStateRepository
static bool addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
 The following functions are for extending state repositories through State Repository Extension classes. More...
 

Protected Attributes

DtSnowStruct mySnow
 
DtSurfaceMoistureEnum16 myMoisture
 
DtRoadIceConditionEnum16 myIceCondition
 
DtBlowingParticulateMatterEnum16 myBlowingParticulateMatter
 
DtU16 myPriority
 
DtFloat64 mySnowMinimumAltitude
 
DtFloat64 mySnowRoadAccumulation
 
DtFloat32 myRainAccumulation
 
DtFloat32 myReferenceTemperatureAltitude
 
DtFloat32 myReferencePressureAltitude
 
bool myIsLightningPresent
 
unsigned int myVisualObscurantColor
 
DtFloat32 myVisualObscurantHeight
 
- Protected Attributes inherited from DtWeatherStateRepository
DtFloat32 myTemperature
 
DtWindStruct myWind
 
DtPrecipitationStruct myPrecipitation
 
DtHazeStruct myHaze
 
DtFloat32 myHumidity
 
DtFloat32 myBarometricPressure
 
DtFloat32 myVisibilityRange
 
- Protected Attributes inherited from DtEnvironmentConditionStateRepository
DtVrlUuid myServiceId
 
DtGeoReferenceVariant myGeoReference
 
bool myIsMakMetocObject
 
- Protected Attributes inherited from DtMetocRootStateRepository
DtVrlUuid myUniqueId
 
DtString myName
 
DtVrlUuid myVrfWeatherAreaId
 

Additional Inherited Members

- Public Types inherited from DtStateRepository
typedef std::map< DtString,
DtStateRepositoryExtension * > 
DtStateRepositoryExtensionMap
 
- Public Attributes inherited from DtStateRepository
DtString myGlobalId
 
DtObjectId myLocalId
 
std::map< RTI::AttributeHandle,
DtGenericAttributeInfo * > 
myAttributesByHandle
 Attributes by handle. More...
 
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
 
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap
 

Detailed Description

Instances of DtLandSurfaceStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather.LandSurface objects.

Constructor & Destructor Documentation

DtLandSurfaceStateRepository::DtLandSurfaceStateRepository ( )

Constructor.

virtual DtLandSurfaceStateRepository::~DtLandSurfaceStateRepository ( )
virtual

Destructor.

DtLandSurfaceStateRepository::DtLandSurfaceStateRepository ( const DtLandSurfaceStateRepository orig)

Copy Constructor.

Member Function Documentation

virtual const DtBlowingParticulateMatterEnum16& DtLandSurfaceStateRepository::blowingParticulateMatter ( ) const
virtual

Get the Blowing Particulate Matter.

virtual DtStateRepository* DtLandSurfaceStateRepository::clone ( bool  copy) const
virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtWeatherStateRepository.

static DtLandSurfaceStateRepository* DtLandSurfaceStateRepository::create ( )
static
virtual const DtRoadIceConditionEnum16& DtLandSurfaceStateRepository::iceCondition ( ) const
virtual

Get the IceCondition.

virtual bool DtLandSurfaceStateRepository::isLightningPresent ( ) const
virtual

Get if lightning is present in this weather area.

virtual const DtSurfaceMoistureEnum16& DtLandSurfaceStateRepository::moisture ( ) const
virtual

Get the Moisture.

DtLandSurfaceStateRepository& DtLandSurfaceStateRepository::operator= ( const DtLandSurfaceStateRepository orig)

Assignment Operator.

virtual void DtLandSurfaceStateRepository::printData ( ) const
virtual

Print data to the DtInfo stream.

Reimplemented from DtWeatherStateRepository.

virtual void DtLandSurfaceStateRepository::printDataToStream ( std::ostream &  stream) const
virtual

Print data to the specified stream.

Reimplemented from DtWeatherStateRepository.

virtual const DtU16& DtLandSurfaceStateRepository::priority ( ) const
virtual

Get the Priority.

virtual DtFloat32 DtLandSurfaceStateRepository::rainAccumulation ( ) const
virtual

Get the rain accumulation on this land surface in meters.

virtual DtFloat32 DtLandSurfaceStateRepository::referencePressureAltitude ( ) const
virtual

Get the reference altitude for pressure.

virtual DtFloat32 DtLandSurfaceStateRepository::referenceTemperatureAltitude ( ) const
virtual

Get the reference altitude for temperature.

virtual void DtLandSurfaceStateRepository::setBlowingParticulateMatter ( const DtBlowingParticulateMatterEnum16 val)
virtual

Set the Blowing Particulate Matter.

virtual void DtLandSurfaceStateRepository::setIceCondition ( const DtRoadIceConditionEnum16 val)
virtual

Set the IceCondition.

virtual void DtLandSurfaceStateRepository::setIsLightningPresent ( bool  val)
virtual

Set if lightning is present in this weather area.

virtual void DtLandSurfaceStateRepository::setMoisture ( const DtSurfaceMoistureEnum16 moisture)
virtual

Set the Moisture.

virtual const void DtLandSurfaceStateRepository::setPriority ( const DtU16 val)
virtual

Set the priority level. Used when METOC objects overlap.

virtual void DtLandSurfaceStateRepository::setRainAccumulation ( DtFloat32  val)
virtual

Set the rain accumulation on this land surface in meters.

virtual void DtLandSurfaceStateRepository::setReferencePressureAltitude ( DtFloat32  val)
virtual

Set the reference altitude for pressure.

virtual void DtLandSurfaceStateRepository::setReferenceTemperatureAltitude ( DtFloat32  val)
virtual

Set the reference altitude for temperature.

virtual void DtLandSurfaceStateRepository::setSnow ( const DtSnowStruct ss)
virtual

Set the Snow.

virtual void DtLandSurfaceStateRepository::setSnowMinimumAltitude ( const DtFloat64 val)
virtual

Set the SnowMinimumAltitude.

virtual void DtLandSurfaceStateRepository::setSnowRoadAccumulation ( const DtFloat64 val)
virtual

Set the SnowRoadAccumulation.

virtual void DtLandSurfaceStateRepository::setVisualObscurantColor ( int  r,
int  g,
int  b,
int  a 
)
virtual

Set the visual obscurant color (R, G, B, A)

virtual void DtLandSurfaceStateRepository::setVisualObscurantColor ( unsigned int  color)
virtual

Set the visual obscurant color with an encoded integer value.

virtual void DtLandSurfaceStateRepository::setVisualObscurantHeight ( DtFloat32  val)
virtual

Set the height of the visual obscurant affect.

virtual const DtSnowStruct& DtLandSurfaceStateRepository::snow ( ) const
virtual

Get the Snow.

virtual const DtFloat64& DtLandSurfaceStateRepository::snowMinimumAltitude ( ) const
virtual

Get the SnowMinimumAltitude.

virtual const DtFloat64& DtLandSurfaceStateRepository::snowRoadAccumulation ( ) const
virtual

Get the SnowRoadAccumulation.

virtual unsigned int DtLandSurfaceStateRepository::visualObscurantColor ( ) const
virtual

Get the encoded integer value of the visual obscurant color.

virtual DtFloat32 DtLandSurfaceStateRepository::visualObscurantHeight ( ) const
virtual

Get the height of the visual obscurant affect.

Member Data Documentation

DtBlowingParticulateMatterEnum16 DtLandSurfaceStateRepository::myBlowingParticulateMatter
protected
DtRoadIceConditionEnum16 DtLandSurfaceStateRepository::myIceCondition
protected
bool DtLandSurfaceStateRepository::myIsLightningPresent
protected
DtSurfaceMoistureEnum16 DtLandSurfaceStateRepository::myMoisture
protected
DtU16 DtLandSurfaceStateRepository::myPriority
protected
DtFloat32 DtLandSurfaceStateRepository::myRainAccumulation
protected
DtFloat32 DtLandSurfaceStateRepository::myReferencePressureAltitude
protected
DtFloat32 DtLandSurfaceStateRepository::myReferenceTemperatureAltitude
protected
DtSnowStruct DtLandSurfaceStateRepository::mySnow
protected
DtFloat64 DtLandSurfaceStateRepository::mySnowMinimumAltitude
protected
DtFloat64 DtLandSurfaceStateRepository::mySnowRoadAccumulation
protected
unsigned int DtLandSurfaceStateRepository::myVisualObscurantColor
protected
DtFloat32 DtLandSurfaceStateRepository::myVisualObscurantHeight
protected

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

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)