CigiBaseHatHotReq Class Reference

#include <CigiBaseHatHotReq.h>

Inheritance diagram for CigiBaseHatHotReq:

CigiBasePacket CigiHatHotReqV3 CigiHatHotReqV3_2 CigiHatReqV1 CigiHatReqV2 CigiHotReqV2 List of all members.

Public Types

 HAT = 0
 HOT = 1
 Extended = 2
 Geodetic = 0
 Entity = 1
enum  ReqTypeGrp { HAT = 0, HOT = 1, Extended = 2 }
enum  CoordSysGrp { Geodetic = 0, Entity = 1 }

Public Member Functions

 CigiBaseHatHotReq ()
virtual ~CigiBaseHatHotReq ()
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 SetLat (const double LatIn, bool bndchk=true)
double GetLat (void) const
int SetLon (const double LonIn, bool bndchk=true)
double GetLon (void) const

Protected Attributes

Cigi_uint16 HatHotID
ReqTypeGrp ReqType
CoordSysGrp SrcCoordSys
Cigi_uint8 UpdatePeriod
Cigi_uint16 EntityID
double LatOrXoff
double LonOrYoff
double AltOrZoff
bool IsValidV1or2

Friends

class CigiHatReqV1
class CigiHatReqV2
class CigiHotReqV2
class CigiHatHotReqV3
class CigiHatHotReqV3_2

Detailed Description

Definition at line 92 of file CigiBaseHatHotReq.h.

Member Enumeration Documentation

enum CigiBaseHatHotReq::CoordSysGrp

The enumeration for the CigiBaseHatHotReq Group

Enumerator:
Geodetic 
Entity 

Definition at line 116 of file CigiBaseHatHotReq.h.

00117    {
00118       Geodetic=0,
00119       Entity=1
00120    };

enum CigiBaseHatHotReq::ReqTypeGrp

The enumeration for the CigiBaseHatHotReq Group

Enumerator:
HAT 
HOT 
Extended 

Definition at line 106 of file CigiBaseHatHotReq.h.

00107    {
00108       HAT=0,
00109       HOT=1,
00110       Extended=2
00111    };

Constructor & Destructor Documentation

CigiBaseHatHotReq::CigiBaseHatHotReq (  ) 

General Constructor

Definition at line 56 of file CigiBaseHatHotReq.cpp.

00057 {
00058 
00059 }

CigiBaseHatHotReq::~CigiBaseHatHotReq (  )  [virtual]

General Destructor

Definition at line 66 of file CigiBaseHatHotReq.cpp.

00067 {
00068 
00069 }

Member Function Documentation

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

Gets the HatHotID value.

Returns:
the current HatHotID.

Definition at line 187 of file CigiBaseHatHotReq.h.

References HatHotID.

00187 { return(HatHotID); }

double CigiBaseHatHotReq::GetLat ( void   )  const [inline]

Gets the Lat value.

Returns:
the current Lat.

Definition at line 204 of file CigiBaseHatHotReq.h.

References LatOrXoff.

00204 { return(LatOrXoff); }

double CigiBaseHatHotReq::GetLon ( void   )  const [inline]

Gets the Lon value.

Returns:
the current Lon.

Definition at line 221 of file CigiBaseHatHotReq.h.

References LonOrYoff.

00221 { return(LonOrYoff); }

virtual int CigiBaseHatHotReq::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 CigiHatHotReqV3, CigiHatHotReqV3_2, CigiHatReqV1, CigiHatReqV2, and CigiHotReqV2.

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

Sets the HatHotID with bound checking control

Parameters:
HatHotIDIn - HAT/HOT Request 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 178 of file CigiBaseHatHotReq.h.

References CIGI_SUCCESS, and HatHotID.

00179    {
00180       HatHotID = HatHotIDIn;
00181       return(CIGI_SUCCESS);
00182    }

int CigiBaseHatHotReq::SetLat ( const double  LatIn,
bool  bndchk = true 
)

Sets the Lat with bound checking control

Parameters:
LatIn - The Latitude of the location to check.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 79 of file CigiBaseHatHotReq.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and LatOrXoff.

00080 {
00081 
00082 #ifndef CIGI_NO_BND_CHK
00083    if(bndchk && ((LatIn < -90.0)||(LatIn > 90.0)))
00084    {
00085 #ifndef CIGI_NO_EXCEPT
00086       throw CigiValueOutOfRangeException("Lat",(double)LatIn,-90.0,90.0);
00087 #endif
00088       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00089    }
00090 #endif
00091 
00092    LatOrXoff = LatIn;
00093    return(CIGI_SUCCESS);
00094 
00095 }

int CigiBaseHatHotReq::SetLon ( const double  LonIn,
bool  bndchk = true 
)

Sets the Lon with bound checking control

Parameters:
LonIn - The Longitude of the location to check.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 101 of file CigiBaseHatHotReq.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and LonOrYoff.

00102 {
00103 
00104 #ifndef CIGI_NO_BND_CHK
00105    if(bndchk && ((LonIn < -180.0)||(LonIn > 180.0)))
00106    {
00107 #ifndef CIGI_NO_EXCEPT
00108       throw CigiValueOutOfRangeException("Lon",(double)LonIn,-180.0,180.0);
00109 #endif
00110       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00111    }
00112 #endif
00113 
00114    LonOrYoff = LonIn;
00115    return(CIGI_SUCCESS);
00116 
00117 }

virtual int CigiBaseHatHotReq::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 CigiHatHotReqV3, CigiHatHotReqV3_2, CigiHatReqV1, CigiHatReqV2, and CigiHotReqV2.

Friends And Related Function Documentation

friend class CigiHatHotReqV3 [friend]

Definition at line 98 of file CigiBaseHatHotReq.h.

friend class CigiHatHotReqV3_2 [friend]

Definition at line 99 of file CigiBaseHatHotReq.h.

friend class CigiHatReqV1 [friend]

Definition at line 95 of file CigiBaseHatHotReq.h.

friend class CigiHatReqV2 [friend]

Definition at line 96 of file CigiBaseHatHotReq.h.

friend class CigiHotReqV2 [friend]

Definition at line 97 of file CigiBaseHatHotReq.h.

Member Data Documentation

double CigiBaseHatHotReq::AltOrZoff [protected]

AltOrZoff
The position of the request point specified as altitude or an offset along the Z axis of the origin entity measured from the origin of that entity.

Definition at line 288 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHatReqV2::Pack(), CigiHatReqV1::Pack(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

Cigi_uint16 CigiBaseHatHotReq::EntityID [protected]

EntityID
The ID of the Origin Entity

Definition at line 264 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

Cigi_uint16 CigiBaseHatHotReq::HatHotID [protected]

HatHotID
HAT/HOT Request ID.

Definition at line 233 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), GetHatHotID(), CigiHotReqV2::Pack(), CigiHatReqV2::Pack(), CigiHatReqV1::Pack(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), SetHatHotID(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

bool CigiBaseHatHotReq::IsValidV1or2 [protected]

IsValidV1or2
Whether the data is valid for CIGI 1 and/or 2

Definition at line 294 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHotReqV2::Pack(), CigiHatReqV2::Pack(), CigiHatReqV1::Pack(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

double CigiBaseHatHotReq::LatOrXoff [protected]

LatOrXoff
The position of the request point specified as latitude or an offset along the X axis of the origin entity measured from the origin of that entity.

Definition at line 272 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), GetLat(), CigiHotReqV2::Pack(), CigiHatReqV2::Pack(), CigiHatReqV1::Pack(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), SetLat(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

double CigiBaseHatHotReq::LonOrYoff [protected]

LonOrYoff
The position of the request point specified as longitude or an offset along the Y axis of the origin entity measured from the origin of that entity.

Definition at line 280 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), GetLon(), CigiHotReqV2::Pack(), CigiHatReqV2::Pack(), CigiHatReqV1::Pack(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), SetLon(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

ReqTypeGrp CigiBaseHatHotReq::ReqType [protected]

ReqType
The type of request and response desired
0-HAT
1-HOT
2-Extended

Definition at line 242 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHatHotReqV3_2::GetCnvt(), CigiHatHotReqV3::GetCnvt(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), CigiHatHotReqV3_2::SetReqType(), CigiHatHotReqV3::SetReqType(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

CoordSysGrp CigiBaseHatHotReq::SrcCoordSys [protected]

SrcCoordSys
The Coordinate system of the point data. 0-Geodetic
1-Entity

Definition at line 251 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHatHotReqV3_2::Pack(), CigiHatHotReqV3::Pack(), CigiHatHotReqV3_2::SetSrcCoordSys(), CigiHatHotReqV3::SetSrcCoordSys(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

Cigi_uint8 CigiBaseHatHotReq::UpdatePeriod [protected]

UpdatePeriod
The number of frames between each hat/hot update from the IG. If 0 - single shot

Definition at line 258 of file CigiBaseHatHotReq.h.

Referenced by CigiHatHotReqV3::CigiHatHotReqV3(), CigiHatHotReqV3_2::CigiHatHotReqV3_2(), CigiHatReqV1::CigiHatReqV1(), CigiHatReqV2::CigiHatReqV2(), CigiHotReqV2::CigiHotReqV2(), CigiHatHotReqV3_2::Pack(), CigiHotReqV2::Unpack(), CigiHatReqV2::Unpack(), CigiHatReqV1::Unpack(), CigiHatHotReqV3_2::Unpack(), and CigiHatHotReqV3::Unpack().

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