VR-Link API Documentation for HLA 1.3
 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 | Static Protected Attributes
DtLandSurfaceRecord Class Reference
+ Inheritance diagram for DtLandSurfaceRecord:
+ Collaboration diagram for DtLandSurfaceRecord:

Public Member Functions

 DtLandSurfaceRecord ()
 Constructor. More...
 
 DtLandSurfaceRecord (const DtLandSurfaceRecord &orig)
 Copy Constructor. More...
 
 DtLandSurfaceRecord (void *netBuffer, unsigned int size)
 Net Constructor. More...
 
virtual DtLandSurfaceRecordoperator= (const DtLandSurfaceRecord &record)
 Assignment Operator. More...
 
virtual DtStandardVariableRecordoperator= (const DtStandardVariableRecord &other)
 Assignment operator. More...
 
virtual bool operator== (const DtLandSurfaceRecord &record)
 Equals Operator. More...
 
virtual bool operator== (const DtStandardVariableRecord &other)
 Equals operator. More...
 
virtual void setSnowStruct (const DtSnowStruct &layer)
 Set the Snow Struct. More...
 
virtual const DtSnowStruct snowStruct () const
 Get the Snow Struct. 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 &ic)
 Set the IceCondition. More...
 
virtual const
DtRoadIceConditionEnum16 
iceCondition () const
 Get the IceCondition. More...
 
virtual void setSnowMinimumAlt (const DtFloat64 &sal)
 Set the SnowMinimumAlt. More...
 
virtual const DtFloat64 snowMinimumAlt () const
 Get the SnowMinimumAlt. More...
 
virtual void setSnowRoadAccumulation (const DtFloat64 &sal)
 Set the SnowRoadAccumulation. More...
 
virtual const DtFloat64 snowRoadAccumulation () const
 Get the SnowRoadAccumulation. More...
 
virtual void setReferenceTemperatureAltitude (const DtFloat32 &val)
 Set the ReferenceTemperatureAltitude. More...
 
virtual const DtFloat32 referenceTemperatureAltitude () const
 Get the ReferenceTemperatureAltitude. More...
 
virtual void setReferencePressureAltitude (const DtFloat32 &val)
 Set the ReferencePressureAltitude. More...
 
virtual const DtFloat32 referencePressureAltitude () const
 Get the ReferencePressureAltitude. More...
 
virtual void setRainAccumulation (const DtFloat32 &val)
 Set the RainAccumulation. More...
 
virtual const DtFloat32 rainAccumulation () const
 Get the RainAccumulation. More...
 
virtual void setVisualObscurantColor (const DtU32 &val)
 Set the VisualObscurantColor. More...
 
virtual const DtU32 visualObscurantColor () const
 Get the VisualObscurantColor. More...
 
virtual void setVisualObscurantHeight (const DtFloat32 &val)
 Set the VisualObscurantHeight. More...
 
virtual const DtFloat32 visualObscurantHeight () const
 Get the VisualObscurantHeight. More...
 
virtual void setIsLightningPresent (const bool &val)
 Set the IsLightningPresent. More...
 
virtual const bool isLightningPresent () const
 Get the IsLightningPresent. More...
 
virtual void writeRecord (void *addr) const
 
virtual void setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
 Sets the record from an address and length. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Prints the data to the specified stream. More...
 
virtual unsigned int unpaddedNetsize () const
 This is the network size of the record without padding. More...
 
virtual unsigned int paddedNetSize () const
 This is the network size of the record with padding. More...
 
virtual DtStandardVariableRecordclone () const
 Clone. More...
 
- Public Member Functions inherited from DtMetocLayerRecord
 DtMetocLayerRecord ()
 Constructor. More...
 
 DtMetocLayerRecord (const DtMetocLayerRecord &orig)
 Copy Constructor. More...
 
 DtMetocLayerRecord (void *netBuffer, unsigned int size)
 Net Constructor. More...
 
virtual DtMetocLayerRecordoperator= (const DtMetocLayerRecord &record)
 Assignment Operator. More...
 
virtual bool operator== (const DtMetocLayerRecord &record)
 Equals Operator. More...
 
virtual void setPriority (unsigned short priority)
 
virtual unsigned short priority () const
 
virtual void setVrfWeatherAreaIdentifier (const DtVrlUuid &vrfWeatherAreaId)
 
virtual DtVrlUuid vrfWeatherAreaIdentifier () const
 
virtual unsigned int recordType () const
 Get/Set Record Type. More...
 
virtual void setRecordType (unsigned int recordType)
 Get/Set Record Type. More...
 
virtual unsigned int recordLength () const
 Get/Set Record Length. More...
 
virtual void setRecordLength (unsigned int length)
 Must include size of record header and padding to 8 bytes. More...
 
- Public Member Functions inherited from DtStandardVariableRecord
 DtStandardVariableRecord ()
 Constructor. More...
 
virtual ~DtStandardVariableRecord ()
 Destructor. More...
 
virtual void printData () const
 Prints the data to DtInfo. More...
 
virtual unsigned int netSize ()
 Returns the size of the network representation (including padding bytes) More...
 
virtual void setOriginatingSimulationAddress (const DtSimulationAddress &)
 
virtual const DtSimulationAddressoriginatingSimulationAddress () const
 

Static Public Member Functions

static DtStandardVariableRecordcreate (void *addr, unsigned int length)
 Creator of an unknown record for registering in a factory. More...
 
static unsigned int recordTypeToUse ()
 Return the landSurface record type. More...
 
static void setRecordTypeToUse (unsigned int typeToUse)
 Set the record type to use. More...
 
- Static Public Member Functions inherited from DtMetocLayerRecord
static DtStandardVariableRecordcreate (void *addr, unsigned int length)
 Creator of an unknown record for registering in a factory. More...
 
static unsigned int recordTypeToUse ()
 Return the METOC Layer record type. More...
 
static void setRecordTypeToUse (unsigned int typeToUse)
 Set the record type to use. More...
 

Protected Attributes

DtNetLandSurfaceRecordmyRecordPtr
 
- Protected Attributes inherited from DtMetocLayerRecord
std::vector< char > myRecordBuffer
 
- Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress myOriginatingSimulationAddress
 

Static Protected Attributes

static const unsigned int theMinimumSize
 
- Static Protected Attributes inherited from DtMetocLayerRecord
static const unsigned int theMinimumSize
 

Constructor & Destructor Documentation

DtLandSurfaceRecord::DtLandSurfaceRecord ( )

Constructor.

DtLandSurfaceRecord::DtLandSurfaceRecord ( const DtLandSurfaceRecord orig)

Copy Constructor.

DtLandSurfaceRecord::DtLandSurfaceRecord ( void *  netBuffer,
unsigned int  size 
)

Net Constructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtLandSurfaceRecord::clone ( ) const
virtual

Clone.

Reimplemented from DtMetocLayerRecord.

static DtStandardVariableRecord* DtLandSurfaceRecord::create ( void *  addr,
unsigned int  length 
)
static

Creator of an unknown record for registering in a factory.

virtual const DtRoadIceConditionEnum16 DtLandSurfaceRecord::iceCondition ( ) const
virtual

Get the IceCondition.

virtual const bool DtLandSurfaceRecord::isLightningPresent ( ) const
virtual

Get the IsLightningPresent.

virtual const DtSurfaceMoistureEnum16 DtLandSurfaceRecord::moisture ( ) const
virtual

Get the Moisture.

virtual DtLandSurfaceRecord& DtLandSurfaceRecord::operator= ( const DtLandSurfaceRecord record)
virtual

Assignment Operator.

virtual DtStandardVariableRecord& DtLandSurfaceRecord::operator= ( const DtStandardVariableRecord other)
virtual

Assignment operator.

Reimplemented from DtMetocLayerRecord.

virtual bool DtLandSurfaceRecord::operator== ( const DtLandSurfaceRecord record)
virtual

Equals Operator.

virtual bool DtLandSurfaceRecord::operator== ( const DtStandardVariableRecord other)
virtual

Equals operator.

Reimplemented from DtMetocLayerRecord.

virtual unsigned int DtLandSurfaceRecord::paddedNetSize ( ) const
virtual

This is the network size of the record with padding.

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

Prints the data to the specified stream.

Reimplemented from DtMetocLayerRecord.

virtual const DtFloat32 DtLandSurfaceRecord::rainAccumulation ( ) const
virtual

Get the RainAccumulation.

static unsigned int DtLandSurfaceRecord::recordTypeToUse ( )
static

Return the landSurface record type.

virtual const DtFloat32 DtLandSurfaceRecord::referencePressureAltitude ( ) const
virtual

Get the ReferencePressureAltitude.

virtual const DtFloat32 DtLandSurfaceRecord::referenceTemperatureAltitude ( ) const
virtual

Get the ReferenceTemperatureAltitude.

virtual void DtLandSurfaceRecord::setFromNet ( const void *  netRecord,
unsigned int  length,
DtStandardVariableRetCode retCode = NULL 
)
virtual

Sets the record from an address and length.

Return code will be Valid if all goes well. Memory must exist for life of the variable record

Reimplemented from DtMetocLayerRecord.

virtual void DtLandSurfaceRecord::setIceCondition ( const DtRoadIceConditionEnum16 ic)
virtual

Set the IceCondition.

virtual void DtLandSurfaceRecord::setIsLightningPresent ( const bool val)
virtual

Set the IsLightningPresent.

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

Set the Moisture.

virtual void DtLandSurfaceRecord::setRainAccumulation ( const DtFloat32 val)
virtual

Set the RainAccumulation.

static void DtLandSurfaceRecord::setRecordTypeToUse ( unsigned int  typeToUse)
static

Set the record type to use.

virtual void DtLandSurfaceRecord::setReferencePressureAltitude ( const DtFloat32 val)
virtual

Set the ReferencePressureAltitude.

virtual void DtLandSurfaceRecord::setReferenceTemperatureAltitude ( const DtFloat32 val)
virtual

Set the ReferenceTemperatureAltitude.

virtual void DtLandSurfaceRecord::setSnowMinimumAlt ( const DtFloat64 sal)
virtual

Set the SnowMinimumAlt.

virtual void DtLandSurfaceRecord::setSnowRoadAccumulation ( const DtFloat64 sal)
virtual

Set the SnowRoadAccumulation.

virtual void DtLandSurfaceRecord::setSnowStruct ( const DtSnowStruct layer)
virtual

Set the Snow Struct.

virtual void DtLandSurfaceRecord::setVisualObscurantColor ( const DtU32 val)
virtual

Set the VisualObscurantColor.

virtual void DtLandSurfaceRecord::setVisualObscurantHeight ( const DtFloat32 val)
virtual

Set the VisualObscurantHeight.

virtual const DtFloat64 DtLandSurfaceRecord::snowMinimumAlt ( ) const
virtual

Get the SnowMinimumAlt.

virtual const DtFloat64 DtLandSurfaceRecord::snowRoadAccumulation ( ) const
virtual

Get the SnowRoadAccumulation.

virtual const DtSnowStruct DtLandSurfaceRecord::snowStruct ( ) const
virtual

Get the Snow Struct.

virtual unsigned int DtLandSurfaceRecord::unpaddedNetsize ( ) const
virtual

This is the network size of the record without padding.

Reimplemented from DtMetocLayerRecord.

virtual const DtU32 DtLandSurfaceRecord::visualObscurantColor ( ) const
virtual

Get the VisualObscurantColor.

virtual const DtFloat32 DtLandSurfaceRecord::visualObscurantHeight ( ) const
virtual

Get the VisualObscurantHeight.

virtual void DtLandSurfaceRecord::writeRecord ( void *  addr) const
virtual

Reimplemented from DtMetocLayerRecord.

Member Data Documentation

DtNetLandSurfaceRecord* DtLandSurfaceRecord::myRecordPtr
protected
const unsigned int DtLandSurfaceRecord::theMinimumSize
staticprotected

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)