VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
landSurfaceRecord.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2023 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
10 
11 #pragma once
12 
13 #include <vl/iceStruct.h>
14 #include <vl/metocLayerRecord.h>
16 #include <vl/snowStruct.h>
17 
18 
20 {
21 public:
24 
27 
29  DtLandSurfaceRecord(void* netBuffer, unsigned int size);
30 
32  virtual DtLandSurfaceRecord& operator=(const DtLandSurfaceRecord& record);
33 
36 
38  virtual bool operator==(const DtLandSurfaceRecord& record);
39 
41  virtual bool operator==(const DtStandardVariableRecord& other);
42 
44  virtual void setSnowStruct(const DtSnowStruct& layer);
45 
47  virtual const DtSnowStruct snowStruct() const;
48 
50  virtual void setMoisture(const DtSurfaceMoistureEnum16& moisture);
51 
53  virtual const DtSurfaceMoistureEnum16 moisture() const;
54 
56  virtual void setIceCondition(const DtRoadIceConditionEnum16& ic);
57 
59  virtual const DtRoadIceConditionEnum16 iceCondition() const;
60 
62  virtual void setSnowMinimumAlt(const DtFloat64& sal);
63 
65  virtual const DtFloat64 snowMinimumAlt() const;
66 
68  virtual void setSnowRoadAccumulation(const DtFloat64& sal);
69 
71  virtual const DtFloat64 snowRoadAccumulation() const;
72 
74  virtual void setReferenceTemperatureAltitude(const DtFloat32& val);
75 
77  virtual const DtFloat32 referenceTemperatureAltitude() const;
78 
80  virtual void setReferencePressureAltitude(const DtFloat32& val);
81 
83  virtual const DtFloat32 referencePressureAltitude() const;
84 
86  virtual void setRainAccumulation(const DtFloat32& val);
87 
89  virtual const DtFloat32 rainAccumulation() const;
90 
92  virtual void setVisualObscurantColor(const DtU32& val);
93 
95  virtual const DtU32 visualObscurantColor() const;
96 
98  virtual void setVisualObscurantHeight(const DtFloat32& val);
99 
101  virtual const DtFloat32 visualObscurantHeight() const;
102 
104  virtual void setIsLightningPresent(const bool& val);
105 
107  virtual const bool isLightningPresent() const;
108 
109  // Writes the network representation to the given address.
110  // The assumption is that this memory is allocated and is of the proper size.
111  virtual void writeRecord(void* addr) const;
112 
115  virtual void setFromNet(const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL);
116 
118  virtual void printDataToStream(std::ostream& stream) const;
119 
121  virtual unsigned int unpaddedNetsize() const;
122 
124  virtual unsigned int paddedNetSize() const;
125 
127  virtual DtStandardVariableRecord* clone() const;
128 
129 public:
131  static DtStandardVariableRecord* create(void* addr, unsigned int length);
132 
134  static unsigned int recordTypeToUse();
135 
137  static void setRecordTypeToUse(unsigned int typeToUse);
138 
139 protected:
141 
142 protected:
143  static const unsigned int theMinimumSize;
144 
145 };
146 
DtNetLandSurfaceRecord * myRecordPtr
Definition: landSurfaceRecord.h:140
virtual unsigned int unpaddedNetsize() const
This is the network size of the record without padding.
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
DtRoadIceConditionEnum16
Definition: metocEnums.h:56
static DtStandardVariableRecord * create(void *addr, unsigned int length)
Creator of an unknown record for registering in a factory.
Definition: snowStruct.h:22
Definition: metocLayerRecord.h:12
static unsigned int recordTypeToUse()
Return the METOC Layer record type.
This file declares DtNetLandSurfaceRecord.
static const unsigned int theMinimumSize
Definition: landSurfaceRecord.h:143
virtual DtStandardVariableRecord * clone() const
Clone.
virtual void setFromNet(const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
Sets the record from an address and length.
virtual bool operator==(const DtMetocLayerRecord &record)
Equals Operator.
virtual DtMetocLayerRecord & operator=(const DtMetocLayerRecord &record)
Assignment Operator.
DtSurfaceMoistureEnum16
Definition: metocEnums.h:68
Definition: landSurfaceRecordP.h:17
Definition: standardVariableRecord.h:22
unsigned long DtU32
A 32 bit unsigned integer value.
Definition: vlMachineTypes.h:153
DtStandardVariableRetCode
Definition: standardVariableRecord.h:14
virtual void writeRecord(void *addr) const
Definition: landSurfaceRecord.h:19
virtual void printDataToStream(std::ostream &stream) const
Prints the data to the specified stream.
static void setRecordTypeToUse(unsigned int typeToUse)
Set the record type to use.

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)