CigiVersionID Class Reference

#include <CigiVersionID.h>

List of all members.

Public Member Functions

 CigiVersionID (void)
 CigiVersionID (int CigiMajorVersionIn, int CigiMinorVersionIn)
virtual ~CigiVersionID (void)
void SetCigiVersion (int CigiMajorVersionIn, int CigiMinorVersionIn)
int GetCombinedCigiVersion (void)
bool IsKnownCigiVersion (void)
void BestCigiVersion (void)
bool operator== (const CigiVersionID &TestVersion)
bool operator!= (const CigiVersionID &TestVersion)
bool operator> (const CigiVersionID &TestVersion)
bool operator>= (const CigiVersionID &TestVersion)
bool operator< (const CigiVersionID &TestVersion)
bool operator<= (const CigiVersionID &TestVersion)

Public Attributes

int CigiMajorVersion
int CigiMinorVersion

Detailed Description

Definition at line 47 of file CigiVersionID.h.

Constructor & Destructor Documentation

CigiVersionID::CigiVersionID ( void   )  [inline]

General Constructor

Definition at line 57 of file CigiVersionID.h.

00058       : CigiMajorVersion(0)
00059       , CigiMinorVersion(0)
00060    {
00061    }

CigiVersionID::CigiVersionID ( int  CigiMajorVersionIn,
int  CigiMinorVersionIn 
) [inline]

Initializing Constructor

Definition at line 66 of file CigiVersionID.h.

00067       : CigiMajorVersion(CigiMajorVersionIn)
00068       , CigiMinorVersion(CigiMinorVersionIn)
00069    {
00070    }

virtual CigiVersionID::~CigiVersionID ( void   )  [inline, virtual]

General Destructor

Definition at line 75 of file CigiVersionID.h.

00076    {
00077    }

Member Function Documentation

void CigiVersionID::BestCigiVersion ( void   )  [inline]

Determines if the best match to a known version of CIGI

Definition at line 144 of file CigiVersionID.h.

Referenced by CigiIncomingMsg::CheckFirstPacket().

00145    {
00146       if((CigiMajorVersion == 1) || (CigiMajorVersion == 2))
00147          CigiMinorVersion = 0;
00148       else if(CigiMajorVersion == 3)
00149       {
00150          if(CigiMinorVersion > 3)
00151             CigiMinorVersion = 3;
00152          else if(CigiMinorVersion < 2)
00153             CigiMinorVersion = 0;
00154       }
00155       else
00156       {
00157          // Set the version to the most mature version of CIGI
00158          CigiMajorVersion = 3;
00159          CigiMinorVersion = 3;
00160       }
00161    }

int CigiVersionID::GetCombinedCigiVersion ( void   )  [inline]

Gets the value indicating if a valid IGCtrl or SOF packet has been packed for the message.

Returns:
This returns a value indicating if a valid IGCtrl or SOF packet has been packed

Definition at line 105 of file CigiVersionID.h.

Referenced by CigiOutgoingMsg::ChangeBufferCigiVersion(), CigiIncomingMsg::CheckFirstPacket(), CigiBaseSymbolTextDef::GetCnvt(), CigiBaseSymbolSurfaceDef::GetCnvt(), CigiBaseSymbolLineDef::GetCnvt(), CigiBaseSymbolCtrl::GetCnvt(), CigiBaseSymbolClone::GetCnvt(), CigiBaseSymbolCircleDef::GetCnvt(), CigiBaseShortSymbolCtrl::GetCnvt(), CigiSOFV3_2::Pack(), CigiIGCtrlV3_3::Pack(), CigiIGCtrlV3_2::Pack(), CigiOutgoingMsg::SetMostMatureReceivedCigiVersion(), and CigiOutgoingMsg::UpdateFrameCntr().

00106    {
00107       int CVer = ((CigiMajorVersion << 8) & 0x0000ff00) | 
00108                   (CigiMinorVersion & 0x000000ff);
00109 
00110       return(CVer);
00111    }

bool CigiVersionID::IsKnownCigiVersion ( void   )  [inline]

Determines if the version of CIGI is a known version.

Returns:
This returns a value indicating if a know version of CIGI is stored

Definition at line 120 of file CigiVersionID.h.

Referenced by CigiIncomingMsg::CheckFirstPacket(), CigiOutgoingMsg::SetMostMatureReceivedCigiVersion(), CigiOutgoingMsg::SetOutgoingCigiVersion(), and CigiIncomingMsg::SetReaderVersion().

00121    {
00122       bool KnownVer = false;
00123       if(CigiMajorVersion > 0)
00124       {
00125          if(CigiMajorVersion < 3)
00126          {
00127             if(CigiMinorVersion == 0)
00128                KnownVer = true;
00129          }
00130          else if(CigiMajorVersion == 3)
00131          {
00132             if((CigiMinorVersion >= 0) && (CigiMinorVersion <= 3))
00133                KnownVer = true;
00134          }
00135       }
00136 
00137       return(KnownVer);
00138    }

bool CigiVersionID::operator!= ( const CigiVersionID &  TestVersion  )  [inline]

Testing for Not Equal

Returns:
This returns true if the versions are not the same

Definition at line 182 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00183    {
00184       return((CigiMajorVersion != TestVersion.CigiMajorVersion) ||
00185               (CigiMinorVersion != TestVersion.CigiMinorVersion));
00186    }

bool CigiVersionID::operator< ( const CigiVersionID &  TestVersion  )  [inline]

Tests for Less than

Returns:
This returns true if the second version is a less mature version.

Definition at line 232 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00233    {
00234       bool Rslt = false;
00235       if(CigiMajorVersion < TestVersion.CigiMajorVersion)
00236          Rslt = true;
00237       else if(CigiMajorVersion == TestVersion.CigiMajorVersion)
00238       {
00239          if(CigiMinorVersion < TestVersion.CigiMinorVersion)
00240             Rslt = true;
00241       }
00242       return(Rslt);
00243    }

bool CigiVersionID::operator<= ( const CigiVersionID &  TestVersion  )  [inline]

Tests for less than or equal to

Returns:
This returns true if the second version is the same or a less mature version.

Definition at line 251 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00252    {
00253       bool Rslt = false;
00254       if(CigiMajorVersion < TestVersion.CigiMajorVersion)
00255          Rslt = true;
00256       else if(CigiMajorVersion == TestVersion.CigiMajorVersion)
00257       {
00258          if(CigiMinorVersion <= TestVersion.CigiMinorVersion)
00259             Rslt = true;
00260       }
00261       return(Rslt);
00262    }

bool CigiVersionID::operator== ( const CigiVersionID &  TestVersion  )  [inline]

Testing for equality

Returns:
This returns true if the versions are the same

Definition at line 171 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00172    {
00173       return((CigiMajorVersion == TestVersion.CigiMajorVersion) &&
00174               (CigiMinorVersion == TestVersion.CigiMinorVersion));
00175    }

bool CigiVersionID::operator> ( const CigiVersionID &  TestVersion  )  [inline]

Tests for greater than

Returns:
This returns true if the second version is a more mature version.

Definition at line 194 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00195    {
00196       bool Rslt = false;
00197       if(CigiMajorVersion > TestVersion.CigiMajorVersion)
00198          Rslt = true;
00199       else if(CigiMajorVersion == TestVersion.CigiMajorVersion)
00200       {
00201          if(CigiMinorVersion > TestVersion.CigiMinorVersion)
00202             Rslt = true;
00203       }
00204       return(Rslt);
00205    }

bool CigiVersionID::operator>= ( const CigiVersionID &  TestVersion  )  [inline]

Tests for greater than or equal to

Returns:
This returns true if the second version is the same or a more mature version.

Definition at line 213 of file CigiVersionID.h.

References CigiMajorVersion, and CigiMinorVersion.

00214    {
00215       bool Rslt = false;
00216       if(CigiMajorVersion > TestVersion.CigiMajorVersion)
00217          Rslt = true;
00218       else if(CigiMajorVersion == TestVersion.CigiMajorVersion)
00219       {
00220          if(CigiMinorVersion >= TestVersion.CigiMinorVersion)
00221             Rslt = true;
00222       }
00223       return(Rslt);
00224    }

void CigiVersionID::SetCigiVersion ( int  CigiMajorVersionIn,
int  CigiMinorVersionIn 
) [inline]

Gets the value indicating if a valid IGCtrl or SOF packet has been packed for the message.

Returns:
This returns a value indicating if a valid IGCtrl or SOF packet has been packed

Definition at line 89 of file CigiVersionID.h.

Referenced by CigiOutgoingMsg::AdvanceBuffer(), CigiIncomingMsg::CigiIncomingMsg(), CigiOutgoingMsg::CigiOutgoingMsg(), CigiSOFV3_2::Pack(), CigiIGCtrlV3_3::Pack(), CigiIGCtrlV3_2::Pack(), and CigiOutgoingMsg::SetOutgoingCigiVersion().

00090    {
00091       CigiMajorVersion = CigiMajorVersionIn;
00092       CigiMinorVersion = CigiMinorVersionIn;
00093    }

Member Data Documentation

int CigiVersionID::CigiMajorVersion

Buffer Created
Specifies whether the buffer has been created.

Definition at line 271 of file CigiVersionID.h.

Referenced by CigiOutgoingMsg::AdvanceBuffer(), CigiOutgoingMsg::ChangeBufferCigiVersion(), CigiOutgoingMsg::ChangeOutgoingCigiVersion(), CigiIncomingMsg::CheckFirstPacket(), CigiShortCompCtrlV3_3::GetCnvt(), CigiShortCompCtrlV3::GetCnvt(), CigiSensorXRespV3::GetCnvt(), CigiLosXRespV3_2::GetCnvt(), CigiLosXRespV3::GetCnvt(), CigiLosRespV3_2::GetCnvt(), CigiLosRespV3::GetCnvt(), CigiLosRespV2::GetCnvt(), CigiLosRespV1::GetCnvt(), CigiHotRespV2::GetCnvt(), CigiHotReqV2::GetCnvt(), CigiHatReqV2::GetCnvt(), CigiHatReqV1::GetCnvt(), CigiHatHotXRespV3_2::GetCnvt(), CigiHatHotXRespV3::GetCnvt(), CigiHatHotRespV3_2::GetCnvt(), CigiHatHotRespV3::GetCnvt(), CigiHatHotReqV3_2::GetCnvt(), CigiHatHotReqV3::GetCnvt(), CigiCompCtrlV3_3::GetCnvt(), CigiCompCtrlV3::GetCnvt(), CigiCompCtrlV2::GetCnvt(), CigiCompCtrlV1::GetCnvt(), CigiBaseWeatherCtrl::GetCnvt(), CigiBaseWeatherCondResp::GetCnvt(), CigiBaseWaveCtrl::GetCnvt(), CigiBaseViewDef::GetCnvt(), CigiBaseViewCtrl::GetCnvt(), CigiBaseTrajectoryDef::GetCnvt(), CigiBaseTerrestrialSurfaceCtrl::GetCnvt(), CigiBaseSpecEffDef::GetCnvt(), CigiBaseShortArtPartCtrl::GetCnvt(), CigiBaseSensorResp::GetCnvt(), CigiBaseSensorCtrl::GetCnvt(), CigiBasePositionResp::GetCnvt(), CigiBasePositionReq::GetCnvt(), CigiBaseMotionTrackCtrl::GetCnvt(), CigiBaseMaritimeSurfaceResp::GetCnvt(), CigiBaseMaritimeSurfaceCtrl::GetCnvt(), CigiBaseLosVectReq::GetCnvt(), CigiBaseLosSegReq::GetCnvt(), CigiBaseEventNotification::GetCnvt(), CigiBaseEnvRgnCtrl::GetCnvt(), CigiBaseEnvCondReq::GetCnvt(), CigiBaseConfClampEntityCtrl::GetCnvt(), CigiBaseCollDetVolResp::GetCnvt(), CigiBaseCollDetVolDef::GetCnvt(), CigiBaseCollDetSegResp::GetCnvt(), CigiBaseArtPartCtrl::GetCnvt(), CigiBaseAerosolResp::GetCnvt(), CigiBaseTerrestrialSurfaceResp::GetCnvt(), CigiBaseRateCtrl::GetCnvt(), CigiBaseIGMsg::GetCnvt(), CigiBaseEarthModelDef::GetCnvt(), CigiBaseCollDetSegDef::GetCnvt(), CigiBaseAnimationStop::GetCnvt(), operator!=(), operator<(), CigiOutgoingMsg::operator<<(), operator<=(), operator==(), operator>(), operator>=(), CigiSOFV3_2::Pack(), CigiIGCtrlV3_3::Pack(), CigiIGCtrlV3_2::Pack(), CigiIncomingMsg::ProcessIncomingMsg(), CigiSession::SetCigiVersion(), CigiIncomingMsg::SetReaderVersion(), and CigiOutgoingMsg::UpdateFrameCntr().

int CigiVersionID::CigiMinorVersion

Buffer Created
Specifies whether the buffer has been created.

Definition at line 277 of file CigiVersionID.h.

Referenced by CigiIncomingMsg::CheckFirstPacket(), CigiShortCompCtrlV3_3::GetCnvt(), CigiShortCompCtrlV3::GetCnvt(), CigiCompCtrlV3_3::GetCnvt(), CigiCompCtrlV3::GetCnvt(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), CigiSOFV3_2::Pack(), CigiIGCtrlV3_3::Pack(), CigiIGCtrlV3_2::Pack(), CigiSession::SetCigiVersion(), CigiIncomingMsg::SetIncomingHostV3Tbls(), CigiIncomingMsg::SetIncomingIGV3Tbls(), CigiOutgoingMsg::SetOutgoingHostV3Tbls(), CigiOutgoingMsg::SetOutgoingIGV3Tbls(), CigiIncomingMsg::SetReaderVersion(), and CigiOutgoingMsg::UpdateFrameCntr().

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