CigiBaseTrajectoryDef Class Reference

#include <CigiBaseTrajectoryDef.h>

Inheritance diagram for CigiBaseTrajectoryDef:

CigiBasePacket CigiTrajectoryDefV1 CigiTrajectoryDefV2 CigiTrajectoryDefV3 List of all members.

Public Member Functions

 CigiBaseTrajectoryDef ()
virtual ~CigiBaseTrajectoryDef ()
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 SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true)
Cigi_uint16 GetEntityID (void) const
int SetRetardationRate (const float RetardationRateIn, bool bndchk=true)
float GetRetardationRate (void) const
int SetTermVel (const float TermVelIn, bool bndchk=true)
float GetTermVel (void) const

Protected Attributes

Cigi_uint16 EntityID
float Accel
float RetardationRate
float TermVel
float Xoff
float Yoff
float Zoff
float AccelX
float AccelY
float AccelZ

Friends

class CigiTrajectoryDefV1
class CigiTrajectoryDefV2
class CigiTrajectoryDefV3

Detailed Description

Definition at line 79 of file CigiBaseTrajectoryDef.h.

Constructor & Destructor Documentation

CigiBaseTrajectoryDef::CigiBaseTrajectoryDef (  ) 

General Constructor

Definition at line 60 of file CigiBaseTrajectoryDef.cpp.

00061 {
00062 
00063 }

CigiBaseTrajectoryDef::~CigiBaseTrajectoryDef (  )  [virtual]

General Destructor

Definition at line 70 of file CigiBaseTrajectoryDef.cpp.

00071 {
00072 
00073 }

Member Function Documentation

int CigiBaseTrajectoryDef::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 84 of file CigiBaseTrajectoryDef.cpp.

References CIGI_SUCCESS, CIGI_TRAJECTORY_DEF_PACKET_ID_V2, CIGI_TRAJECTORY_DEF_PACKET_ID_V3, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00086 {
00087    CnvtInfo.ProcID = CigiProcessType::ProcStd;
00088 
00089    // V1 & V2 have the same packet id number
00090    if(CnvtVersion.CigiMajorVersion < 3)
00091       CnvtInfo.CnvtPacketID = CIGI_TRAJECTORY_DEF_PACKET_ID_V2;
00092    else
00093       CnvtInfo.CnvtPacketID = CIGI_TRAJECTORY_DEF_PACKET_ID_V3;
00094 
00095    return(CIGI_SUCCESS);
00096 }

Cigi_uint16 CigiBaseTrajectoryDef::GetEntityID ( void   )  const [inline]

Gets the EntityIDIn value.

Returns:
the current EntityIDIn.

Definition at line 166 of file CigiBaseTrajectoryDef.h.

References EntityID.

00166 { return(EntityID); }

float CigiBaseTrajectoryDef::GetRetardationRate ( void   )  const [inline]

Gets the RetardationRate value.

Returns:
the current RetardationRate.

Definition at line 187 of file CigiBaseTrajectoryDef.h.

References RetardationRate.

00187 { return(RetardationRate); }

float CigiBaseTrajectoryDef::GetTermVel ( void   )  const [inline]

Gets the TermVel value.

Returns:
the current TermVel.

Definition at line 208 of file CigiBaseTrajectoryDef.h.

References TermVel.

00208 { return(TermVel); }

virtual int CigiBaseTrajectoryDef::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 CigiTrajectoryDefV1, CigiTrajectoryDefV2, and CigiTrajectoryDefV3.

int CigiBaseTrajectoryDef::SetEntityID ( const Cigi_uint16  EntityIDIn,
bool  bndchk = true 
) [inline]

Sets the EntityID with bound checking control

Parameters:
EntityIDIn - The Entity 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 157 of file CigiBaseTrajectoryDef.h.

References CIGI_SUCCESS, and EntityID.

00158    {
00159       EntityID = EntityIDIn;
00160       return(CIGI_SUCCESS);
00161    }

int CigiBaseTrajectoryDef::SetRetardationRate ( const float  RetardationRateIn,
bool  bndchk = true 
) [inline]

Sets the RetardationRate with bound checking control

Parameters:
RetardationRateIn - Deceleration usually due to drag.
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 CigiBaseTrajectoryDef.h.

References CIGI_SUCCESS, and RetardationRate.

00179    {
00180       RetardationRate = RetardationRateIn;
00181       return(CIGI_SUCCESS);
00182    }

int CigiBaseTrajectoryDef::SetTermVel ( const float  TermVelIn,
bool  bndchk = true 
) [inline]

Sets the TermVel with bound checking control

Parameters:
TermVelIn - The terminal velocity.
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 CigiBaseTrajectoryDef.h.

References CIGI_SUCCESS, and TermVel.

00200    {
00201       TermVel = TermVelIn;
00202       return(CIGI_SUCCESS);
00203    }

virtual int CigiBaseTrajectoryDef::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 - This is not used in this class.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiTrajectoryDefV1, CigiTrajectoryDefV2, and CigiTrajectoryDefV3.

Friends And Related Function Documentation

friend class CigiTrajectoryDefV1 [friend]

Definition at line 82 of file CigiBaseTrajectoryDef.h.

friend class CigiTrajectoryDefV2 [friend]

Definition at line 83 of file CigiBaseTrajectoryDef.h.

friend class CigiTrajectoryDefV3 [friend]

Definition at line 84 of file CigiBaseTrajectoryDef.h.

Member Data Documentation

float CigiBaseTrajectoryDef::Accel [protected]

Accel
Acceleration (usually due to gravity)

Definition at line 227 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV2::Pack(), CigiTrajectoryDefV1::Pack(), CigiTrajectoryDefV3::SetAccelX(), CigiTrajectoryDefV3::SetAccelY(), CigiTrajectoryDefV3::SetAccelZ(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::AccelX [protected]

AccelX
The acceleration along the X (North) axis

Definition at line 266 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV3::SetAccelX(), CigiTrajectoryDefV3::SetAccelY(), CigiTrajectoryDefV3::SetAccelZ(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::AccelY [protected]

AccelY
The acceleration along the Y (East) axis

Definition at line 272 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV3::SetAccelX(), CigiTrajectoryDefV3::SetAccelY(), CigiTrajectoryDefV3::SetAccelZ(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::AccelZ [protected]

AccelZ
The acceleration along the Z (Down) axis

Definition at line 278 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV3::SetAccelX(), CigiTrajectoryDefV3::SetAccelY(), CigiTrajectoryDefV3::SetAccelZ(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

Cigi_uint16 CigiBaseTrajectoryDef::EntityID [protected]

EntityID
Uniquely identifies the entity to which this packet is applied.

Definition at line 221 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), GetEntityID(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV2::Pack(), CigiTrajectoryDefV1::Pack(), SetEntityID(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::RetardationRate [protected]

RetardationRate
Deceleration (usually due to drag)

Definition at line 233 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), GetRetardationRate(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV2::Pack(), CigiTrajectoryDefV1::Pack(), SetRetardationRate(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::TermVel [protected]

TermVel
Terminal Velocity

Definition at line 239 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), GetTermVel(), CigiTrajectoryDefV3::Pack(), CigiTrajectoryDefV2::Pack(), CigiTrajectoryDefV1::Pack(), SetTermVel(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::Xoff [protected]

Xoff
The offset along the entity's X axis from the entity's reference point from which the trajectory is started.

Definition at line 246 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV1::Pack(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::Yoff [protected]

Yoff
The offset along the entity's Y axis from the entity's reference point from which the trajectory is started.

Definition at line 253 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV1::Pack(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

float CigiBaseTrajectoryDef::Zoff [protected]

Zoff
The offset along the entity's Z axis from the entity's reference point from which the trajectory is started.

Definition at line 260 of file CigiBaseTrajectoryDef.h.

Referenced by CigiTrajectoryDefV1::CigiTrajectoryDefV1(), CigiTrajectoryDefV2::CigiTrajectoryDefV2(), CigiTrajectoryDefV3::CigiTrajectoryDefV3(), CigiTrajectoryDefV1::Pack(), CigiTrajectoryDefV3::Unpack(), CigiTrajectoryDefV2::Unpack(), and CigiTrajectoryDefV1::Unpack().

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