CigiBaseEarthModelDef Class Reference

#include <CigiBaseEarthModelDef.h>

Inheritance diagram for CigiBaseEarthModelDef:

CigiBasePacket CigiEarthModelDefV3 List of all members.

Public Member Functions

 CigiBaseEarthModelDef ()
virtual ~CigiBaseEarthModelDef ()
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 SetCustomERMEn (const bool CustomERMEnIn, bool bndchk=true)
bool GetCustomERMEn (void) const
int SetEquatorialRadius (const double EquatorialRadiusIn, bool bndchk=true)
double GetEquatorialRadius (void) const
int SetFlattening (const double FlatteningIn, bool bndchk=true)
double GetFlattening (void) const

Protected Attributes

bool CustomERMEn
double EquatorialRadius
double Flattening

Friends

class CigiEarthModelDefV3

Detailed Description

Definition at line 68 of file CigiBaseEarthModelDef.h.

Constructor & Destructor Documentation

CigiBaseEarthModelDef::CigiBaseEarthModelDef (  )  [inline]

General Constructor

Definition at line 80 of file CigiBaseEarthModelDef.h.

00080 { };

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

General Destructor

Definition at line 85 of file CigiBaseEarthModelDef.h.

00085 { };

Member Function Documentation

virtual int CigiBaseEarthModelDef::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [inline, 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 127 of file CigiBaseEarthModelDef.h.

References CIGI_EARTH_MODEL_DEF_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00129    {
00130       if(CnvtVersion.CigiMajorVersion < 3)
00131       {
00132          CnvtInfo.ProcID = CigiProcessType::ProcNone;
00133          CnvtInfo.CnvtPacketID = 0;
00134       }
00135       else
00136       {
00137          CnvtInfo.ProcID = CigiProcessType::ProcStd;
00138          CnvtInfo.CnvtPacketID = CIGI_EARTH_MODEL_DEF_PACKET_ID_V3;
00139       }
00140 
00141       return(CIGI_SUCCESS);
00142    }

bool CigiBaseEarthModelDef::GetCustomERMEn ( void   )  const [inline]

Gets the CustomERMEn value.

Returns:
the current CustomERMEn.

Definition at line 166 of file CigiBaseEarthModelDef.h.

References CustomERMEn.

00166 { return(CustomERMEn); }

double CigiBaseEarthModelDef::GetEquatorialRadius ( void   )  const [inline]

Gets the EquatorialRadius value.

Returns:
the current EquatorialRadius.

Definition at line 187 of file CigiBaseEarthModelDef.h.

References EquatorialRadius.

00187 { return(EquatorialRadius); }

double CigiBaseEarthModelDef::GetFlattening ( void   )  const [inline]

Gets the Flattening value.

Returns:
the current Flattening.

Definition at line 208 of file CigiBaseEarthModelDef.h.

References Flattening.

00208 { return(Flattening); }

virtual int CigiBaseEarthModelDef::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 CigiEarthModelDefV3.

int CigiBaseEarthModelDef::SetCustomERMEn ( const bool  CustomERMEnIn,
bool  bndchk = true 
) [inline]

Sets the CustomERMEn with bound checking control

Parameters:
CustomERMEnIn - Custom Earth Referance Model Enable
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 157 of file CigiBaseEarthModelDef.h.

References CIGI_SUCCESS, and CustomERMEn.

00158    {
00159       CustomERMEn = CustomERMEnIn;
00160       return(CIGI_SUCCESS);
00161    }

int CigiBaseEarthModelDef::SetEquatorialRadius ( const double  EquatorialRadiusIn,
bool  bndchk = true 
) [inline]

Sets the EquatorialRadius with bound checking control

Parameters:
EquatorialRadiusIn - Equatorial Radius
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 CigiBaseEarthModelDef.h.

References CIGI_SUCCESS, and EquatorialRadius.

00179    {
00180       EquatorialRadius = EquatorialRadiusIn;
00181       return(CIGI_SUCCESS);
00182    }

int CigiBaseEarthModelDef::SetFlattening ( const double  FlatteningIn,
bool  bndchk = true 
) [inline]

Sets the Flattening with bound checking control

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

Definition at line 199 of file CigiBaseEarthModelDef.h.

References CIGI_SUCCESS, and Flattening.

00200    {
00201       Flattening = FlatteningIn;
00202       return(CIGI_SUCCESS);
00203    }

virtual int CigiBaseEarthModelDef::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 CigiEarthModelDefV3.

Friends And Related Function Documentation

friend class CigiEarthModelDefV3 [friend]

Definition at line 71 of file CigiBaseEarthModelDef.h.

Member Data Documentation

bool CigiBaseEarthModelDef::CustomERMEn [protected]

CustomERMEn
Custom Earth Referance Model Enable

Definition at line 220 of file CigiBaseEarthModelDef.h.

Referenced by CigiEarthModelDefV3::CigiEarthModelDefV3(), GetCustomERMEn(), CigiEarthModelDefV3::Pack(), SetCustomERMEn(), and CigiEarthModelDefV3::Unpack().

double CigiBaseEarthModelDef::EquatorialRadius [protected]

EquatorialRadius
Equatorial Radius

Definition at line 226 of file CigiBaseEarthModelDef.h.

Referenced by CigiEarthModelDefV3::CigiEarthModelDefV3(), GetEquatorialRadius(), CigiEarthModelDefV3::Pack(), SetEquatorialRadius(), and CigiEarthModelDefV3::Unpack().

double CigiBaseEarthModelDef::Flattening [protected]

Flattening
Adjustment parameter that specifies the ellipsiod shape.

Definition at line 232 of file CigiBaseEarthModelDef.h.

Referenced by CigiEarthModelDefV3::CigiEarthModelDefV3(), GetFlattening(), CigiEarthModelDefV3::Pack(), SetFlattening(), and CigiEarthModelDefV3::Unpack().

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