CigiBaseHatHotResp Class Reference

#include <CigiBaseHatHotResp.h>

Inheritance diagram for CigiBaseHatHotResp:

CigiBasePacket CigiHatHotRespV3 CigiHatHotRespV3_2 CigiHatHotXRespV3 CigiHatHotXRespV3_2 CigiHatRespV1 CigiHatRespV2 CigiHotRespV2 List of all members.

Public Types

 HAT = 0
 HOT = 1
enum  ReqTypeGrp { HAT = 0, HOT = 1 }

Public Member Functions

 CigiBaseHatHotResp ()
virtual ~CigiBaseHatHotResp ()
virtual int Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0
int SetHatHotID (const Cigi_uint16 HatHotIDIn, bool bndchk=true)
Cigi_uint16 GetHatHotID (void) const
int SetValid (const bool ValidIn, bool bndchk=true)
bool GetValid (void) const

Protected Attributes

Cigi_uint16 HatHotID
bool Valid
Cigi_uint8 HostFrame
ReqTypeGrp ReqType
double Hat
double Hot
Cigi_uint32 Material
float NormAz
float NormEl
bool VldHat
bool VldHot

Friends

class CigiHatRespV1
class CigiHatRespV2
class CigiHotRespV2
class CigiHatHotRespV3
class CigiHatHotXRespV3
class CigiHatHotRespV3_2
class CigiHatHotXRespV3_2

Detailed Description

Definition at line 105 of file CigiBaseHatHotResp.h.

Member Enumeration Documentation

enum CigiBaseHatHotResp::ReqTypeGrp

The enumeration for the CigiBaseHatHotResp Group

Enumerator:
HAT 
HOT 

Definition at line 121 of file CigiBaseHatHotResp.h.

00122    {
00123       HAT=0,
00124       HOT=1
00125    };

Constructor & Destructor Documentation

CigiBaseHatHotResp::CigiBaseHatHotResp (  )  [inline]

General Constructor

Definition at line 135 of file CigiBaseHatHotResp.h.

00135 { };

virtual CigiBaseHatHotResp::~CigiBaseHatHotResp (  )  [inline, virtual]

General Destructor

Definition at line 140 of file CigiBaseHatHotResp.h.

00140 { };

Member Function Documentation

Cigi_uint16 CigiBaseHatHotResp::GetHatHotID ( void   )  const [inline]

Gets the HatHotID value.

Returns:
the current HatHotID.

Definition at line 192 of file CigiBaseHatHotResp.h.

References HatHotID.

00192 { return(HatHotID); }

bool CigiBaseHatHotResp::GetValid ( void   )  const [inline]

Gets the Valid value.

Returns:
the current Valid.

Definition at line 213 of file CigiBaseHatHotResp.h.

References Valid.

00213 { return(Valid); }

virtual int CigiBaseHatHotResp::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 CigiHatHotRespV3, CigiHatHotRespV3_2, CigiHatHotXRespV3, CigiHatHotXRespV3_2, CigiHatRespV1, CigiHatRespV2, and CigiHotRespV2.

int CigiBaseHatHotResp::SetHatHotID ( const Cigi_uint16  HatHotIDIn,
bool  bndchk = true 
) [inline]

Sets the HatHotID with bound checking control

Parameters:
HatHotIDIn - Hat/Hot Request/Response ID
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 CigiBaseHatHotResp.h.

References CIGI_SUCCESS, and HatHotID.

00184    {
00185       HatHotID = HatHotIDIn;
00186       return(CIGI_SUCCESS);
00187    }

int CigiBaseHatHotResp::SetValid ( const bool  ValidIn,
bool  bndchk = true 
) [inline]

Sets the Valid with bound checking control

Parameters:
ValidIn - Data is valid.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 204 of file CigiBaseHatHotResp.h.

References CIGI_SUCCESS, and Valid.

00205    {
00206       Valid = ValidIn;
00207       return(CIGI_SUCCESS);
00208    }

virtual int CigiBaseHatHotResp::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 CigiHatHotRespV3, CigiHatHotRespV3_2, CigiHatHotXRespV3, CigiHatHotXRespV3_2, CigiHatRespV1, CigiHatRespV2, and CigiHotRespV2.

Friends And Related Function Documentation

friend class CigiHatHotRespV3 [friend]

Definition at line 111 of file CigiBaseHatHotResp.h.

friend class CigiHatHotRespV3_2 [friend]

Definition at line 113 of file CigiBaseHatHotResp.h.

friend class CigiHatHotXRespV3 [friend]

Definition at line 112 of file CigiBaseHatHotResp.h.

friend class CigiHatHotXRespV3_2 [friend]

Definition at line 114 of file CigiBaseHatHotResp.h.

friend class CigiHatRespV1 [friend]

Definition at line 108 of file CigiBaseHatHotResp.h.

friend class CigiHatRespV2 [friend]

Definition at line 109 of file CigiBaseHatHotResp.h.

friend class CigiHotRespV2 [friend]

Definition at line 110 of file CigiBaseHatHotResp.h.

Member Data Documentation

double CigiBaseHatHotResp::Hat [protected]

Hat
The Height Above Terrain result data.

Definition at line 253 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatRespV2::Pack(), CigiHatRespV1::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

Cigi_uint16 CigiBaseHatHotResp::HatHotID [protected]

HatHotID
Hat/Hot Request/Response ID.

Definition at line 225 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), GetHatHotID(), CigiHotRespV2::Pack(), CigiHatRespV2::Pack(), CigiHatRespV1::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), SetHatHotID(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

Cigi_uint8 CigiBaseHatHotResp::HostFrame [protected]

HostFrame
The least significant nibble of the Host frame number when the hat/hot was calculated.

Definition at line 238 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatHotXRespV3_2::Pack(), CigiHatHotRespV3_2::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

double CigiBaseHatHotResp::Hot [protected]

Hot
The Height Of Terrain result data

Definition at line 259 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHotRespV2::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

Cigi_uint32 CigiBaseHatHotResp::Material [protected]

Material
The material code of the specified location.

Definition at line 265 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHotRespV2::Pack(), CigiHatRespV2::Pack(), CigiHatRespV1::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

float CigiBaseHatHotResp::NormAz [protected]

NormAz
The Azimuth from true north of the normal vector of the polygon which contains the test point.

Definition at line 272 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotXRespV3_2::SetNormAz(), CigiHatHotXRespV3::SetNormAz(), CigiHatHotXRespV3_2::Unpack(), and CigiHatHotXRespV3::Unpack().

float CigiBaseHatHotResp::NormEl [protected]

NormEl
The Elevation of the normal vector of the polygon which contains the test point.

Definition at line 280 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotXRespV3_2::SetNormEl(), CigiHatHotXRespV3::SetNormEl(), CigiHatHotXRespV3_2::Unpack(), and CigiHatHotXRespV3::Unpack().

ReqTypeGrp CigiBaseHatHotResp::ReqType [protected]

ReqType
The type of response data. 0-HAT
1-HOT

Definition at line 247 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatHotRespV3_2::GetCnvt(), CigiHatHotRespV3::GetCnvt(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), CigiHatHotRespV3_2::SetReqType(), CigiHatHotRespV3::SetReqType(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

bool CigiBaseHatHotResp::Valid [protected]

Valid
Data is valid.

Definition at line 231 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), GetValid(), CigiHotRespV2::Pack(), CigiHatRespV2::Pack(), CigiHatRespV1::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), SetValid(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

bool CigiBaseHatHotResp::VldHat [protected]

VldHat
The Hat data is valid.

Definition at line 286 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHatRespV2::Pack(), CigiHatRespV1::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

bool CigiBaseHatHotResp::VldHot [protected]

VldHot
The Hot data is valid

Definition at line 292 of file CigiBaseHatHotResp.h.

Referenced by CigiHatHotRespV3::CigiHatHotRespV3(), CigiHatHotRespV3_2::CigiHatHotRespV3_2(), CigiHatHotXRespV3::CigiHatHotXRespV3(), CigiHatHotXRespV3_2::CigiHatHotXRespV3_2(), CigiHatRespV1::CigiHatRespV1(), CigiHatRespV2::CigiHatRespV2(), CigiHotRespV2::CigiHotRespV2(), CigiHotRespV2::Pack(), CigiHatHotXRespV3_2::Pack(), CigiHatHotXRespV3::Pack(), CigiHatHotRespV3_2::Pack(), CigiHatHotRespV3::Pack(), CigiHotRespV2::Unpack(), CigiHatRespV2::Unpack(), CigiHatRespV1::Unpack(), CigiHatHotXRespV3_2::Unpack(), CigiHatHotXRespV3::Unpack(), CigiHatHotRespV3_2::Unpack(), and CigiHatHotRespV3::Unpack().

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