CigiBaseEnvCtrl Class Reference

#include <CigiBaseEnvCtrl.h>

Inheritance diagram for CigiBaseEnvCtrl:

CigiBasePacket CigiAtmosCtrlV3 CigiCelestialCtrlV3 CigiEnvCtrlV1 CigiEnvCtrlV2 CigiHoldEnvCtrl List of all members.

Public Member Functions

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)
virtual void FillHold (CigiBaseEnvCtrl *Hold) const =0

Protected Member Functions

 CigiBaseEnvCtrl ()
virtual ~CigiBaseEnvCtrl ()

Protected Attributes

Cigi_uint8 Hour
Cigi_uint8 Minute
Cigi_uint8 Month
Cigi_uint8 Day
Cigi_uint16 Year
float StarInt
bool EphemerisEn
bool SunEn
bool MoonEn
bool StarEn
bool DateVld
bool AtmosEn
float Aerosol
Cigi_uint8 Humidity
float AirTemp
float Visibility
float HorizWindSp
float VertWindSp
float WindDir
float BaroPress

Friends

class CigiEnvCtrlV1
class CigiEnvCtrlV2
class CigiAtmosCtrlV3
class CigiCelestialCtrlV3
class CigiHoldEnvCtrl

Detailed Description

Definition at line 84 of file CigiBaseEnvCtrl.h.

Constructor & Destructor Documentation

CigiBaseEnvCtrl::CigiBaseEnvCtrl (  )  [protected]

General Constructor

Definition at line 56 of file CigiBaseEnvCtrl.cpp.

References Aerosol, AirTemp, AtmosEn, BaroPress, DateVld, Day, EphemerisEn, HorizWindSp, Hour, Humidity, Minute, Month, MoonEn, StarEn, StarInt, SunEn, VertWindSp, Visibility, WindDir, and Year.

00057 {
00058 
00059    Hour = 0;
00060    Minute = 0;
00061    Month = 1;
00062    Day = 1;
00063    Year = 2000;
00064    StarInt = 0.0;
00065    EphemerisEn = false;
00066    SunEn = false;
00067    MoonEn = false;
00068    StarEn = false;
00069    DateVld = false;
00070    AtmosEn = false;
00071    Aerosol = 0.0;
00072    Humidity = 30;
00073    AirTemp = 0.0;
00074    Visibility = 64373.76f;
00075    HorizWindSp = 0.0;
00076    VertWindSp = 0.0;
00077    WindDir = 0.0;
00078    BaroPress = 1013.25;
00079 
00080 }

CigiBaseEnvCtrl::~CigiBaseEnvCtrl (  )  [protected, virtual]

General Destructor

Definition at line 87 of file CigiBaseEnvCtrl.cpp.

00088 {
00089 
00090 }

Member Function Documentation

virtual void CigiBaseEnvCtrl::FillHold ( CigiBaseEnvCtrl *  Hold  )  const [pure virtual]

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

Implemented in CigiAtmosCtrlV3, CigiCelestialCtrlV3, CigiEnvCtrlV1, CigiEnvCtrlV2, and CigiHoldEnvCtrl.

Referenced by CigiIncomingMsg::GetNextPacket(), CigiOutgoingMsg::operator<<(), and CigiIncomingMsg::ProcessIncomingMsg().

int CigiBaseEnvCtrl::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 101 of file CigiBaseEnvCtrl.cpp.

References CIGI_SUCCESS, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiProcessType::ProcEnvCtrl, and CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID.

00103 {
00104    CnvtInfo.ProcID = CigiProcessType::ProcEnvCtrl;
00105    CnvtInfo.CnvtPacketID = 0;
00106 
00107    return(CIGI_SUCCESS);
00108 }

virtual int CigiBaseEnvCtrl::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 CigiAtmosCtrlV3, CigiCelestialCtrlV3, CigiEnvCtrlV1, CigiEnvCtrlV2, and CigiHoldEnvCtrl.

virtual int CigiBaseEnvCtrl::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.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiAtmosCtrlV3, CigiCelestialCtrlV3, CigiEnvCtrlV1, CigiEnvCtrlV2, and CigiHoldEnvCtrl.

Friends And Related Function Documentation

friend class CigiAtmosCtrlV3 [friend]

Definition at line 89 of file CigiBaseEnvCtrl.h.

friend class CigiCelestialCtrlV3 [friend]

Definition at line 90 of file CigiBaseEnvCtrl.h.

friend class CigiEnvCtrlV1 [friend]

Definition at line 87 of file CigiBaseEnvCtrl.h.

friend class CigiEnvCtrlV2 [friend]

Definition at line 88 of file CigiBaseEnvCtrl.h.

friend class CigiHoldEnvCtrl [friend]

Definition at line 91 of file CigiBaseEnvCtrl.h.

Member Data Documentation

float CigiBaseEnvCtrl::Aerosol [protected]

Aerosol
The current aerosol density

Definition at line 249 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV2::SetAerosol(), and CigiEnvCtrlV2::Unpack().

float CigiBaseEnvCtrl::AirTemp [protected]

AirTemp
The current ambient air temperature

Definition at line 261 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiAtmosCtrlV3::Unpack().

bool CigiBaseEnvCtrl::AtmosEn [protected]

AtmosEn
The atmospheric model enable.

Definition at line 243 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), and CigiAtmosCtrlV3::Unpack().

float CigiBaseEnvCtrl::BaroPress [protected]

BaroPress
global barometric pressure

Definition at line 291 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::SetBaroPress(), CigiAtmosCtrlV3::SetBaroPress(), CigiEnvCtrlV2::Unpack(), and CigiAtmosCtrlV3::Unpack().

bool CigiBaseEnvCtrl::DateVld [protected]

DateVld
Date is valid flag.

Definition at line 237 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

Cigi_uint8 CigiBaseEnvCtrl::Day [protected]

Day
The current day of the month.

Definition at line 195 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::SetDay(), CigiEnvCtrlV1::SetDay(), CigiCelestialCtrlV3::SetDay(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

bool CigiBaseEnvCtrl::EphemerisEn [protected]

EphemerisEn
The ephemeris model enable

Definition at line 213 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

float CigiBaseEnvCtrl::HorizWindSp [protected]

HorizWindSp
The horizontal wind speed or more commonly just wind speed.

Definition at line 273 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::SetHorizWindSp(), CigiEnvCtrlV1::SetHorizWindSp(), CigiAtmosCtrlV3::SetHorizWindSp(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiAtmosCtrlV3::Unpack().

Cigi_uint8 CigiBaseEnvCtrl::Hour [protected]

Hour
The current hour.

Definition at line 177 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::SetHour(), CigiEnvCtrlV1::SetHour(), CigiCelestialCtrlV3::SetHour(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

Cigi_uint8 CigiBaseEnvCtrl::Humidity [protected]

Humidity
The current humidity.

Definition at line 255 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::SetHumidity(), CigiEnvCtrlV1::SetHumidity(), CigiAtmosCtrlV3::SetHumidity(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiAtmosCtrlV3::Unpack().

Cigi_uint8 CigiBaseEnvCtrl::Minute [protected]

Minute
The current minute.

Definition at line 183 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::SetMinute(), CigiEnvCtrlV1::SetMinute(), CigiCelestialCtrlV3::SetMinute(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

Cigi_uint8 CigiBaseEnvCtrl::Month [protected]

Month
The current month.

Definition at line 189 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::SetMonth(), CigiEnvCtrlV1::SetMonth(), CigiCelestialCtrlV3::SetMonth(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

bool CigiBaseEnvCtrl::MoonEn [protected]

MoonEn
The Moon enable

Definition at line 225 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

bool CigiBaseEnvCtrl::StarEn [protected]

StarEn
The star field enable.

Definition at line 231 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

float CigiBaseEnvCtrl::StarInt [protected]

StarInt
The Star field intensity.

Definition at line 207 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiCelestialCtrlV3::FillHold(), CigiCelestialCtrlV3::Pack(), CigiCelestialCtrlV3::SetStarInt(), and CigiCelestialCtrlV3::Unpack().

bool CigiBaseEnvCtrl::SunEn [protected]

SunEn
The Sun enable

Definition at line 219 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

float CigiBaseEnvCtrl::VertWindSp [protected]

VertWindSp
The vertical wind speed.

Definition at line 279 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiAtmosCtrlV3::FillHold(), CigiAtmosCtrlV3::Pack(), and CigiAtmosCtrlV3::Unpack().

float CigiBaseEnvCtrl::Visibility [protected]

Visibility
Global visibility

Definition at line 267 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::SetVisibility(), CigiEnvCtrlV1::SetVisibility(), CigiAtmosCtrlV3::SetVisibility(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiAtmosCtrlV3::Unpack().

float CigiBaseEnvCtrl::WindDir [protected]

WindDir
The wind direction.

Definition at line 285 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiAtmosCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiAtmosCtrlV3::Pack(), CigiEnvCtrlV2::SetWindDir(), CigiEnvCtrlV1::SetWindDir(), CigiAtmosCtrlV3::SetWindDir(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiAtmosCtrlV3::Unpack().

Cigi_uint16 CigiBaseEnvCtrl::Year [protected]

Year
The current year.

Definition at line 201 of file CigiBaseEnvCtrl.h.

Referenced by CigiAtmosCtrlV3::CigiAtmosCtrlV3(), CigiBaseEnvCtrl(), CigiCelestialCtrlV3::CigiCelestialCtrlV3(), CigiEnvCtrlV1::CigiEnvCtrlV1(), CigiEnvCtrlV2::CigiEnvCtrlV2(), CigiEnvCtrlV2::FillHold(), CigiEnvCtrlV1::FillHold(), CigiCelestialCtrlV3::FillHold(), CigiEnvCtrlV2::Pack(), CigiEnvCtrlV1::Pack(), CigiCelestialCtrlV3::Pack(), CigiEnvCtrlV2::Unpack(), CigiEnvCtrlV1::Unpack(), and CigiCelestialCtrlV3::Unpack().

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