VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
waterSurfaceStateRepository.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2023 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <matrix/vlVector.h>
14 #include <vl/hlaLogicalTime.h>
16 #include <vlpi/metocEnums.h>
18 #include <vl/iceStruct.h>
19 #include <vl/waterCurrentStruct.h>
20 #include <vl/waveStruct.h>
21 #include <vlpi/entityType.h>
22 #include <vlpi/entityIdentifier.h>
23 #include <vlutil/vlString.h>
24 #include <vlutil/vlMachineTypes.h>
25 
26 #include <vector>
27 
28 
33 {
34 public:
37 
40 
43 
46 
48  virtual DtStateRepository* clone(bool copy) const;
49 
52 
54  virtual void printData() const;
55 
57  virtual void printDataToStream(std::ostream& stream) const;
58 
59 
61  virtual void setSeaState(const DtSeaStateEnum16& val);
62 
64  virtual const DtSeaStateEnum16& seaState() const;
65 
67  virtual void setSalinity(const DtFloat32& val);
68 
70  virtual const DtFloat32& salinity() const;
71 
73  virtual void setTide(const DtFloat32& val);
74 
76  virtual const DtFloat32& tide() const;
77 
79  virtual void setIce(const DtIceStruct& val);
80 
82  virtual const DtIceStruct& ice() const;
83 
85  virtual void setCurrent(const DtWaterCurrentStruct& val);
86 
88  virtual const DtWaterCurrentStruct& current() const;
89 
91  virtual void setWave(const DtWaveStruct& val);
92 
94  virtual const DtWaveStruct& wave() const;
95 
97  virtual void setSwell(const DtWaveStruct& val);
98 
100  virtual const DtWaveStruct& swell() const;
101 
103  virtual void setPriority(const DtU16& val);
104 
106  virtual const DtU16& priority() const;
107 
109  virtual void setChoppiness(DtFloat32 val);
110 
112  virtual DtFloat32 choppiness() const;
113 
115  virtual void setSurgeDepth(DtFloat32 val);
116 
118  virtual DtFloat32 surgeDepth() const;
119 
121  virtual void setSurfaceTransparency(DtFloat32 val);
122 
124  virtual DtFloat32 surfaceTransparency() const;
125 
127  virtual void setDriveSeaStateFromWind(bool val);
128 
130  virtual bool driveSeaStateFromWind() const;
131 
132 protected:
145 };
146 
147 
Contains the DtEntityIdentifier class declaration.
DtWaterCurrentStruct myCurrent
Definition: waterSurfaceStateRepository.h:137
virtual void printDataToStream(std::ostream &stream) const
Print data to the specified stream.
virtual void printData() const
Print data to the DtInfo stream.
DtFloat32 myChoppiness
Definition: waterSurfaceStateRepository.h:141
Contains the DtWeatherStateRepository class declaration.
virtual DtStateRepository * clone(bool copy) const
Return a copy/empty object of the same type as this.
DtFloat32 mySalinity
Definition: waterSurfaceStateRepository.h:134
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
DtWeatherStateRepository & operator=(const DtWeatherStateRepository &orig)
Assignment Operator.
Contains the DtString class declaration.
Contains the DtEntityType and DtRadioEntityType class declarations.
DtSeaStateEnum16 mySeaState
Definition: waterSurfaceStateRepository.h:133
DtU16 myPriority
Definition: waterSurfaceStateRepository.h:140
DtWaveStruct myWave
Definition: waterSurfaceStateRepository.h:138
Definition: iceStruct.h:23
Definition: waveStruct.h:23
This file contains typedefs used to represent objects in a protocol neutral way.
Instances of DtWeatherStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather objects.
Definition: weatherStateRepository.h:33
This file declares DtVector and DtVector32.
DtIceStruct myIce
Definition: waterSurfaceStateRepository.h:136
DtWaveStruct mySwell
Definition: waterSurfaceStateRepository.h:139
Definition: waterCurrentStruct.h:24
DtSeaStateEnum16
Definition: metocEnums.h:78
DtStateRepository is an abstract base class for maintaining state for an object.
Definition: stateRepository.h:50
unsigned short DtU16
A 16 bit unsigned integer value.
Definition: vlMachineTypes.h:140
DtFloat32 mySurgeDepth
Definition: waterSurfaceStateRepository.h:142
static DtWeatherStateRepository * create()
Create a DtWeatherStateRepository.
bool myDriveSeaStateFromWind
Definition: waterSurfaceStateRepository.h:144
DtFloat32 mySurfaceTransparency
Definition: waterSurfaceStateRepository.h:143
Instances of DtWaterSurfaceStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather.WaterSurface objects.
Definition: waterSurfaceStateRepository.h:32
DtFloat32 myTide
Definition: waterSurfaceStateRepository.h:135
This file contains typedefs for machine dependant types.

Document ID: Generated on Thu Sep 19 02:12:35 EDT 2024 from SVN revision 269601
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)