CigiBaseWeatherCtrl Class Reference

#include <CigiBaseWeatherCtrl.h>

Inheritance diagram for CigiBaseWeatherCtrl:

CigiBasePacket CigiWeatherCtrlV1 CigiWeatherCtrlV2 CigiWeatherCtrlV3 List of all members.

Public Types

 None = 0
 Altocumulus = 1
 Altostratus = 2
 Cirrocumulus = 3
 Cirrostratus = 4
 Cirrus = 5
 Cumulonimbus = 6
 Cumulus = 7
 Nimbostratus = 8
 Stratocumulus = 9
 Stratus = 10
 DefA = 11
 DefB = 12
 DefC = 13
 DefD = 14
 DefE = 15
 Global = 0
 Regional = 1
 Entity = 2
enum  CloudTypeGrp {
  None = 0, Altocumulus = 1, Altostratus = 2, Cirrocumulus = 3,
  Cirrostratus = 4, Cirrus = 5, Cumulonimbus = 6, Cumulus = 7,
  Nimbostratus = 8, Stratocumulus = 9, Stratus = 10, DefA = 11,
  DefB = 12, DefC = 13, DefD = 14, DefE = 15
}
enum  ScopeGrp { Global = 0, Regional = 1, Entity = 2 }

Public Member Functions

 CigiBaseWeatherCtrl ()
virtual ~CigiBaseWeatherCtrl ()
virtual int Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0
virtual int GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo)
int SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true)
Cigi_uint16 GetEntityID (void) const
int SetWeatherEn (const bool WeatherEnIn, bool bndchk=true)
bool GetWeatherEn (void) const
int SetScudEn (const bool ScudEnIn, bool bndchk=true)
bool GetScudEn (void) const
int SetRandomWindsEn (const bool RandomWindsEnIn, bool bndchk=true)
bool GetRandomWindsEn (void) const
int SetSeverity (const Cigi_uint8 SeverityIn, bool bndchk=true)
Cigi_uint8 GetSeverity (void) const
int SetAirTemp (const float AirTempIn, bool bndchk=true)
float GetAirTemp (void) const
int SetVisibilityRng (const float VisibilityRngIn, bool bndchk=true)
float GetVisibilityRng (void) const
int SetScudFreq (const float ScudFreqIn, bool bndchk=true)
float GetScudFreq (void) const
int SetCoverage (const float CoverageIn, bool bndchk=true)
float GetCoverage (void) const
int SetBaseElev (const float BaseElevIn, bool bndchk=true)
float GetBaseElev (void) const
int SetThickness (const float ThicknessIn, bool bndchk=true)
float GetThickness (void) const
int SetTransition (const float TransitionIn, bool bndchk=true)
float GetTransition (void) const
int SetHorizWindSp (const float HorizWindSpIn, bool bndchk=true)
float GetHorizWindSp (void) const

Protected Attributes

Cigi_uint16 EntityID
Cigi_uint16 RegionID
Cigi_uint8 LayerID
Cigi_uint8 Humidity
Cigi_uint16 PhenomenonType
bool WeatherEn
bool ScudEn
bool RandomWindsEn
bool RandomLightningEn
CloudTypeGrp CloudType
ScopeGrp Scope
Cigi_uint8 Severity
float AirTemp
float VisibilityRng
float Opacity
float ScudFreq
float Coverage
float BaseElev
float Thickness
float Transition
float HorizWindSp
float VertWindSp
float WindDir
float BaroPress
float Aerosol

Friends

class CigiWeatherCtrlV1
class CigiWeatherCtrlV2
class CigiWeatherCtrlV3

Detailed Description

Definition at line 79 of file CigiBaseWeatherCtrl.h.

Member Enumeration Documentation

enum CigiBaseWeatherCtrl::CloudTypeGrp

The enumeration for the CigiBaseWeatherCtrl Group

Enumerator:
None 
Altocumulus 
Altostratus 
Cirrocumulus 
Cirrostratus 
Cirrus 
Cumulonimbus 
Cumulus 
Nimbostratus 
Stratocumulus 
Stratus 
DefA 
DefB 
DefC 
DefD 
DefE 

Definition at line 91 of file CigiBaseWeatherCtrl.h.

00092    {
00093       None=0,
00094       Altocumulus=1,
00095       Altostratus=2,
00096       Cirrocumulus=3,
00097       Cirrostratus=4,
00098       Cirrus=5,
00099       Cumulonimbus=6,
00100       Cumulus=7,
00101       Nimbostratus=8,
00102       Stratocumulus=9,
00103       Stratus=10,
00104       DefA=11,
00105       DefB=12,
00106       DefC=13,
00107       DefD=14,
00108       DefE=15
00109    };

enum CigiBaseWeatherCtrl::ScopeGrp

The enumeration for the CigiBaseWeatherCtrl Group

Enumerator:
Global 
Regional 
Entity 

Definition at line 114 of file CigiBaseWeatherCtrl.h.

00115    {
00116       Global=0,
00117       Regional=1,
00118       Entity=2
00119    };

Constructor & Destructor Documentation

CigiBaseWeatherCtrl::CigiBaseWeatherCtrl (  ) 

General Constructor

Definition at line 64 of file CigiBaseWeatherCtrl.cpp.

00065 {
00066 
00067 }

CigiBaseWeatherCtrl::~CigiBaseWeatherCtrl (  )  [virtual]

General Destructor

Definition at line 74 of file CigiBaseWeatherCtrl.cpp.

00075 {
00076 
00077 }

Member Function Documentation

float CigiBaseWeatherCtrl::GetAirTemp ( void   )  const [inline]

Gets the AirTemp value.

Returns:
the current AirTemp.

Definition at line 303 of file CigiBaseWeatherCtrl.h.

References AirTemp.

00303 { return(AirTemp); }

float CigiBaseWeatherCtrl::GetBaseElev ( void   )  const [inline]

Gets the BaseElev value.

Returns:
the current BaseElev.

Definition at line 375 of file CigiBaseWeatherCtrl.h.

References BaseElev.

00375 { return(BaseElev); }

int CigiBaseWeatherCtrl::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [virtual]

A virtual Conversion Information function. This function provides conversion information for this packet.

Parameters:
CnvtVersion - The CIGI version to which this packet is being converted.
CnvtInfo - The information needed for conversion
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBasePacket.

Definition at line 88 of file CigiBaseWeatherCtrl.cpp.

References CIGI_SUCCESS, CIGI_WEATHER_CTRL_PACKET_ID_V2, CIGI_WEATHER_CTRL_PACKET_ID_V3, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00090 {
00091    CnvtInfo.ProcID = CigiProcessType::ProcStd;
00092 
00093    // V1 & V2 have the same packet id number
00094    if(CnvtVersion.CigiMajorVersion < 3)
00095       CnvtInfo.CnvtPacketID = CIGI_WEATHER_CTRL_PACKET_ID_V2;
00096    else
00097       CnvtInfo.CnvtPacketID = CIGI_WEATHER_CTRL_PACKET_ID_V3;
00098 
00099    return(CIGI_SUCCESS);
00100 }

float CigiBaseWeatherCtrl::GetCoverage ( void   )  const [inline]

Gets the Coverage value.

Returns:
the current Coverage.

Definition at line 354 of file CigiBaseWeatherCtrl.h.

References Coverage.

00354 { return(Coverage); }

Cigi_uint16 CigiBaseWeatherCtrl::GetEntityID ( void   )  const [inline]

Gets the EntityID value.

Returns:
the current EntityID.

Definition at line 202 of file CigiBaseWeatherCtrl.h.

References EntityID.

00202 { return(EntityID); }

float CigiBaseWeatherCtrl::GetHorizWindSp ( void   )  const [inline]

Gets the HorizWindSp value.

Returns:
the current HorizWindSp.

Definition at line 438 of file CigiBaseWeatherCtrl.h.

References HorizWindSp.

00438 { return(HorizWindSp); }

bool CigiBaseWeatherCtrl::GetRandomWindsEn ( void   )  const [inline]

Gets the RandomWindsEn value.

Returns:
the current RandomWindsEn.

Definition at line 265 of file CigiBaseWeatherCtrl.h.

References RandomWindsEn.

00265 { return(RandomWindsEn); }

bool CigiBaseWeatherCtrl::GetScudEn ( void   )  const [inline]

Gets the ScudEn value.

Returns:
the current ScudEn.

Definition at line 244 of file CigiBaseWeatherCtrl.h.

References ScudEn.

00244 { return(ScudEn); }

float CigiBaseWeatherCtrl::GetScudFreq ( void   )  const [inline]

Gets the ScudFreq value.

Returns:
the current ScudFreq.

Definition at line 337 of file CigiBaseWeatherCtrl.h.

References ScudFreq.

00337 { return(ScudFreq); }

Cigi_uint8 CigiBaseWeatherCtrl::GetSeverity ( void   )  const [inline]

Gets the Severity value.

Returns:
the current Severity.

Definition at line 282 of file CigiBaseWeatherCtrl.h.

References Severity.

00282 { return(Severity); }

float CigiBaseWeatherCtrl::GetThickness ( void   )  const [inline]

Gets the Thickness value.

Returns:
the current Thickness.

Definition at line 396 of file CigiBaseWeatherCtrl.h.

References Thickness.

00396 { return(Thickness); }

float CigiBaseWeatherCtrl::GetTransition ( void   )  const [inline]

Gets the Transition value.

Returns:
the current Transition.

Definition at line 417 of file CigiBaseWeatherCtrl.h.

References Transition.

00417 { return(Transition); }

float CigiBaseWeatherCtrl::GetVisibilityRng ( void   )  const [inline]

Gets the VisibilityRng value.

Returns:
the current VisibilityRng.

Definition at line 320 of file CigiBaseWeatherCtrl.h.

References VisibilityRng.

00320 { return(VisibilityRng); }

bool CigiBaseWeatherCtrl::GetWeatherEn ( void   )  const [inline]

Gets the WeatherEn value.

Returns:
the current WeatherEn.

Definition at line 223 of file CigiBaseWeatherCtrl.h.

References WeatherEn.

00223 { return(WeatherEn); }

virtual int CigiBaseWeatherCtrl::Pack ( CigiBasePacket *  Base,
Cigi_uint8 *  Buff,
void *  Spec 
) const [pure virtual]

A pure virtual Pack function. This function is not implemented in this class.

Parameters:
Base - A pointer to the instance of the packet to be packed. (Downcast to CigiBasePacket)
Buff - A pointer to the current pack point.
Spec - A pointer to special data.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiWeatherCtrlV1, CigiWeatherCtrlV2, and CigiWeatherCtrlV3.

int CigiBaseWeatherCtrl::SetAirTemp ( const float  AirTempIn,
bool  bndchk = true 
) [inline]

Sets the AirTemp with bound checking control

Parameters:
AirTempIn - Air Temperature
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 294 of file CigiBaseWeatherCtrl.h.

References AirTemp, and CIGI_SUCCESS.

00295    {
00296       AirTemp = AirTempIn;
00297       return(CIGI_SUCCESS);
00298    }

int CigiBaseWeatherCtrl::SetBaseElev ( const float  BaseElevIn,
bool  bndchk = true 
) [inline]

Sets the BaseElev with bound checking control

Parameters:
BaseElevIn - Elevation of the cloud base (bottom)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 366 of file CigiBaseWeatherCtrl.h.

References BaseElev, and CIGI_SUCCESS.

00367    {
00368       BaseElev = BaseElevIn;
00369       return(CIGI_SUCCESS);
00370    }

int CigiBaseWeatherCtrl::SetCoverage ( const float  CoverageIn,
bool  bndchk = true 
)

Sets the Coverage with bound checking control

Parameters:
CoverageIn - Weather coverage percentage
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 183 of file CigiBaseWeatherCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Coverage.

00184 {
00185 
00186 #ifndef CIGI_NO_BND_CHK
00187    if(bndchk && ((CoverageIn < 0.0)||(CoverageIn > 100.0)))
00188    {
00189 #ifndef CIGI_NO_EXCEPT
00190       throw CigiValueOutOfRangeException("Coverage",(float)CoverageIn,0.0,100.0);
00191 #endif
00192       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00193    }
00194 #endif
00195 
00196    Coverage = CoverageIn;
00197    return(CIGI_SUCCESS);
00198 
00199 }

int CigiBaseWeatherCtrl::SetEntityID ( const Cigi_uint16  EntityIDIn,
bool  bndchk = true 
) [inline]

Sets the EntityID with bound checking control

Parameters:
EntityIDIn - The entity to which this weather is attached
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 193 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and EntityID.

00194    {
00195       EntityID = EntityIDIn;
00196       return(CIGI_SUCCESS);
00197    }

int CigiBaseWeatherCtrl::SetHorizWindSp ( const float  HorizWindSpIn,
bool  bndchk = true 
) [inline]

Sets the HorizWindSp with bound checking control

Parameters:
HorizWindSpIn - Horizontal Wind speed
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 429 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and HorizWindSp.

00430    {
00431       HorizWindSp = HorizWindSpIn;
00432       return(CIGI_SUCCESS);
00433    }

int CigiBaseWeatherCtrl::SetRandomWindsEn ( const bool  RandomWindsEnIn,
bool  bndchk = true 
) [inline]

Sets the RandomWindsEn with bound checking control

Parameters:
RandomWindsEnIn - Random winds enable(true)/disable(false)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 256 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and RandomWindsEn.

00257    {
00258       RandomWindsEn = RandomWindsEnIn;
00259       return(CIGI_SUCCESS);
00260    }

int CigiBaseWeatherCtrl::SetScudEn ( const bool  ScudEnIn,
bool  bndchk = true 
) [inline]

Sets the ScudEn with bound checking control

Parameters:
ScudEnIn - Scud enable(true)/disable(false)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 235 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and ScudEn.

00236    {
00237       ScudEn = ScudEnIn;
00238       return(CIGI_SUCCESS);
00239    }

int CigiBaseWeatherCtrl::SetScudFreq ( const float  ScudFreqIn,
bool  bndchk = true 
)

Sets the ScudFreq with bound checking control

Parameters:
ScudFreqIn - Scud coverage percentage
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 161 of file CigiBaseWeatherCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and ScudFreq.

00162 {
00163 
00164 #ifndef CIGI_NO_BND_CHK
00165    if(bndchk && ((ScudFreqIn < 0.0)||(ScudFreqIn > 100.0)))
00166    {
00167 #ifndef CIGI_NO_EXCEPT
00168       throw CigiValueOutOfRangeException("ScudFreq",(float)ScudFreqIn,0.0,100.0);
00169 #endif
00170       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00171    }
00172 #endif
00173 
00174    ScudFreq = ScudFreqIn;
00175    return(CIGI_SUCCESS);
00176 
00177 }

int CigiBaseWeatherCtrl::SetSeverity ( const Cigi_uint8  SeverityIn,
bool  bndchk = true 
)

Sets the Severity with bound checking control

Parameters:
SeverityIn - Severity 0(least) to 5(most severe)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 139 of file CigiBaseWeatherCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Severity.

00140 {
00141 
00142 #ifndef CIGI_NO_BND_CHK
00143    if(bndchk && ((SeverityIn < 0)||(SeverityIn > 5)))
00144    {
00145 #ifndef CIGI_NO_EXCEPT
00146       throw CigiValueOutOfRangeException("Severity",(Cigi_uint8)SeverityIn,0,5);
00147 #endif
00148       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00149    }
00150 #endif
00151 
00152    Severity = SeverityIn;
00153    return(CIGI_SUCCESS);
00154 
00155 }

int CigiBaseWeatherCtrl::SetThickness ( const float  ThicknessIn,
bool  bndchk = true 
) [inline]

Sets the Thickness with bound checking control

Parameters:
ThicknessIn - Thickness or height(bottom to top) of the cloud
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 387 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and Thickness.

00388    {
00389       Thickness = ThicknessIn;
00390       return(CIGI_SUCCESS);
00391    }

int CigiBaseWeatherCtrl::SetTransition ( const float  TransitionIn,
bool  bndchk = true 
) [inline]

Sets the Transition with bound checking control

Parameters:
TransitionIn - Thickness of the transition band
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 408 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and Transition.

00409    {
00410       Transition = TransitionIn;
00411       return(CIGI_SUCCESS);
00412    }

int CigiBaseWeatherCtrl::SetVisibilityRng ( const float  VisibilityRngIn,
bool  bndchk = true 
)

Sets the VisibilityRng with bound checking control

Parameters:
VisibilityRngIn - Visibility range
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 111 of file CigiBaseWeatherCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Opacity, and VisibilityRng.

00112 {
00113 
00114 #ifndef CIGI_NO_BND_CHK
00115    if(bndchk && (VisibilityRngIn < 0))
00116    {
00117 #ifndef CIGI_NO_EXCEPT
00118       throw CigiValueOutOfRangeException("VisibilityRng",(double)VisibilityRngIn,">=",0.0);
00119 #endif
00120       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00121    }
00122 #endif
00123 
00124    VisibilityRng = VisibilityRngIn;
00125 
00126    if(VisibilityRng > 70000.0f)
00127       Opacity = 100.0f;
00128    else
00129       Opacity = ((VisibilityRng/70000.0f)*100.0f);
00130 
00131    return(CIGI_SUCCESS);
00132 
00133 }

int CigiBaseWeatherCtrl::SetWeatherEn ( const bool  WeatherEnIn,
bool  bndchk = true 
) [inline]

Sets the WeatherEn with bound checking control

Parameters:
WeatherEnIn - Weather enable(true)/disable(false)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 214 of file CigiBaseWeatherCtrl.h.

References CIGI_SUCCESS, and WeatherEn.

00215    {
00216       WeatherEn = WeatherEnIn;
00217       return(CIGI_SUCCESS);
00218    }

virtual int CigiBaseWeatherCtrl::Unpack ( Cigi_uint8 *  Buff,
bool  Swap,
void *  Spec 
) [pure virtual]

A pure virtual Unpack function. This function is not implemented in this class.

Parameters:
Buff - A pointer to the current pack point.
Swap - N/A for V1 & V2
Spec - A pointer to special data - This is not used in this class.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiWeatherCtrlV1, CigiWeatherCtrlV2, and CigiWeatherCtrlV3.

Friends And Related Function Documentation

friend class CigiWeatherCtrlV1 [friend]

Definition at line 82 of file CigiBaseWeatherCtrl.h.

friend class CigiWeatherCtrlV2 [friend]

Definition at line 83 of file CigiBaseWeatherCtrl.h.

friend class CigiWeatherCtrlV3 [friend]

Definition at line 84 of file CigiBaseWeatherCtrl.h.

Member Data Documentation

float CigiBaseWeatherCtrl::Aerosol [protected]

Aeorsol
Amount of aerosol

Definition at line 618 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::AirTemp [protected]

AirTemp
Temperature of the air.

Definition at line 546 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetAirTemp(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetAirTemp(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::BaroPress [protected]

BaroPress
Barometric pressure

Definition at line 612 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::BaseElev [protected]

BaseElev
Altitude of the base of the cloud

Definition at line 576 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetBaseElev(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetBaseElev(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

CloudTypeGrp CigiBaseWeatherCtrl::CloudType [protected]

CloudType
Type of clouds being controlled.
0-None
1-Altocumulus
2-Altostratus
3-Cirrocumulus
4-Cirrostratus
5-Cirrus
6-Cumulonimbus
7-Cumulus
8-Nimbostratus
9-Stratocumulus
10-Stratus
11-DefA
12-DefB
13-DefC
14-DefD
15-DefE

Definition at line 521 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::SetCloudType(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::Coverage [protected]

Coverage
Percentage of coverage.

Definition at line 570 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetCoverage(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetCoverage(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint16 CigiBaseWeatherCtrl::EntityID [protected]

EntityID
The Entity ID to which this weather is attached

Definition at line 450 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetEntityID(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetEntityID(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::HorizWindSp [protected]

HorizWindSp
Horizontal Wind Speed

Definition at line 594 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetHorizWindSp(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetHorizWindSp(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint8 CigiBaseWeatherCtrl::Humidity [protected]

Humidity
The humidity in this weather zone

Definition at line 468 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::SetHumidity(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint8 CigiBaseWeatherCtrl::LayerID [protected]

LayerID
The Layer ID that this packet controls

Definition at line 462 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV3::SetLayerID(), CigiWeatherCtrlV2::SetPhenomenonType(), CigiWeatherCtrlV1::SetPhenomenonType(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::Opacity [protected]

Opacity
The percentage opacity of the weather

Definition at line 558 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV2::SetOpacity(), CigiWeatherCtrlV1::SetOpacity(), SetVisibilityRng(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint16 CigiBaseWeatherCtrl::PhenomenonType [protected]

PhenomenonType
The type of weather being controlled

Definition at line 474 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV2::SetPhenomenonType(), CigiWeatherCtrlV1::SetPhenomenonType(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

bool CigiBaseWeatherCtrl::RandomLightningEn [protected]

RandomLightningEn
Enables random lightning

Definition at line 498 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

bool CigiBaseWeatherCtrl::RandomWindsEn [protected]

RandomWindsEn
Enables random winds

Definition at line 492 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetRandomWindsEn(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetRandomWindsEn(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint16 CigiBaseWeatherCtrl::RegionID [protected]

RegionID
The Region ID to which this weather is attached

Definition at line 456 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

ScopeGrp CigiBaseWeatherCtrl::Scope [protected]

Scope
Specifies whether the weather being controlled is to be
global, attached to a region, or attached to an entity.
0-Global
1-Regional
2-Entity

Definition at line 532 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV2::SetPhenomenonType(), CigiWeatherCtrlV1::SetPhenomenonType(), CigiWeatherCtrlV3::SetScope(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

bool CigiBaseWeatherCtrl::ScudEn [protected]

ScudEn
Enables Scud

Definition at line 486 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetScudEn(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetScudEn(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::ScudFreq [protected]

ScudFreq
Scud frequency (i.e. percentage coverage.)

Definition at line 564 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetScudFreq(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetScudFreq(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

Cigi_uint8 CigiBaseWeatherCtrl::Severity [protected]

Severity
Weather severity
0-Least severe 5-Most severe

Definition at line 540 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetSeverity(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetSeverity(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::Thickness [protected]

Thickness
Thickness of the cloud from bottom to top.

Definition at line 582 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetThickness(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetThickness(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::Transition [protected]

Transition
Thickness of the transition band

Definition at line 588 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetTransition(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetTransition(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::VertWindSp [protected]

VertWindSp
Verticle Wind Speed

Definition at line 600 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::VisibilityRng [protected]

VisibilityRng
Visibility range

Definition at line 552 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetVisibilityRng(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV2::SetOpacity(), CigiWeatherCtrlV1::SetOpacity(), SetVisibilityRng(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

bool CigiBaseWeatherCtrl::WeatherEn [protected]

WeatherEn
Enables weather

Definition at line 480 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), GetWeatherEn(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), SetWeatherEn(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

float CigiBaseWeatherCtrl::WindDir [protected]

WindDir
Wind direction

Definition at line 606 of file CigiBaseWeatherCtrl.h.

Referenced by CigiWeatherCtrlV1::CigiWeatherCtrlV1(), CigiWeatherCtrlV2::CigiWeatherCtrlV2(), CigiWeatherCtrlV3::CigiWeatherCtrlV3(), CigiWeatherCtrlV3::Pack(), CigiWeatherCtrlV2::Pack(), CigiWeatherCtrlV1::Pack(), CigiWeatherCtrlV3::SetWindDir(), CigiWeatherCtrlV2::SetWindDir(), CigiWeatherCtrlV1::SetWindDir(), CigiWeatherCtrlV3::Unpack(), CigiWeatherCtrlV2::Unpack(), and CigiWeatherCtrlV1::Unpack().

The documentation for this class was generated from the following files:
Generated on Wed Apr 29 09:00:06 2009 for CCL by  doxygen 1.4.7