CigiBaseSensorResp Class Reference

#include <CigiBaseSensorResp.h>

Inheritance diagram for CigiBaseSensorResp:

CigiBasePacket CigiSensorRespV1 CigiSensorRespV2 CigiSensorRespV3 CigiSensorXRespV3 List of all members.

Public Types

 Searching = 0
 Tracking = 1
 NearBrakeLock = 2
 BrakeLock = 3
enum  SensorStatGrp { Searching = 0, Tracking = 1, NearBrakeLock = 2, BrakeLock = 3 }

Public Member Functions

 CigiBaseSensorResp ()
virtual ~CigiBaseSensorResp ()
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 SetSensorID (const Cigi_uint8 SensorIDIn, bool bndchk=true)
Cigi_uint8 GetSensorID (void) const
int SetSensorStat (const SensorStatGrp SensorStatIn, bool bndchk=true)
SensorStatGrp GetSensorStat (void) const
int SetGateSzX (const Cigi_uint16 GateSzXIn, bool bndchk=true)
Cigi_uint16 GetGateSzX (void) const
int SetGateSzY (const Cigi_uint16 GateSzYIn, bool bndchk=true)
Cigi_uint16 GetGateSzY (void) const
int SetGateXoff (const float GateXoffIn, bool bndchk=true)
float GetGateXoff (void) const
int SetGateYoff (const float GateYoffIn, bool bndchk=true)
float GetGateYoff (void) const

Protected Attributes

Cigi_uint16 ViewID
Cigi_uint8 SensorID
SensorStatGrp SensorStat
bool EntityTgt
Cigi_uint16 EntityID
Cigi_uint16 GateSzX
Cigi_uint16 GateSzY
float GateXoff
float GateYoff
Cigi_uint32 FrameCntr
double TrackPntLat
double TrackPntLon
double TrackPntAlt

Friends

class CigiSensorRespV1
class CigiSensorRespV2
class CigiSensorRespV3
class CigiSensorXRespV3

Detailed Description

Definition at line 83 of file CigiBaseSensorResp.h.

Member Enumeration Documentation

enum CigiBaseSensorResp::SensorStatGrp

The enumeration for the CigiBaseSensorResp Group

Enumerator:
Searching 
Tracking 
NearBrakeLock 
BrakeLock 

Definition at line 96 of file CigiBaseSensorResp.h.

00097    {
00098       Searching=0,
00099       Tracking=1,
00100       NearBrakeLock=2,
00101       BrakeLock=3
00102    };

Constructor & Destructor Documentation

CigiBaseSensorResp::CigiBaseSensorResp (  ) 

General Constructor

Definition at line 60 of file CigiBaseSensorResp.cpp.

00061 {
00062 
00063 }

CigiBaseSensorResp::~CigiBaseSensorResp (  )  [virtual]

General Destructor

Definition at line 70 of file CigiBaseSensorResp.cpp.

00071 {
00072 
00073 }

Member Function Documentation

int CigiBaseSensorResp::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.

Reimplemented in CigiSensorXRespV3.

Definition at line 84 of file CigiBaseSensorResp.cpp.

References CIGI_SENSOR_RESP_PACKET_ID_V2, CIGI_SENSOR_RESP_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00086 {
00087    CnvtInfo.ProcID = CigiProcessType::ProcStd;
00088 
00089    // Note: CIGI_SENSOR_RESP_PACKET_ID_V1 &
00090    // CIGI_SENSOR_RESP_PACKET_ID_V2 are the same
00091    if(CnvtVersion.CigiMajorVersion < 3)
00092       CnvtInfo.CnvtPacketID = CIGI_SENSOR_RESP_PACKET_ID_V2;
00093    else
00094       CnvtInfo.CnvtPacketID = CIGI_SENSOR_RESP_PACKET_ID_V3;
00095 
00096    return(CIGI_SUCCESS);
00097 }

Cigi_uint16 CigiBaseSensorResp::GetGateSzX ( void   )  const [inline]

Gets the GateSzX value.

Returns:
the current GateSzX.

Definition at line 226 of file CigiBaseSensorResp.h.

References GateSzX.

00226 { return(GateSzX); }

Cigi_uint16 CigiBaseSensorResp::GetGateSzY ( void   )  const [inline]

Gets the GateSzY value.

Returns:
the current GateSzY.

Definition at line 247 of file CigiBaseSensorResp.h.

References GateSzY.

00247 { return(GateSzY); }

float CigiBaseSensorResp::GetGateXoff ( void   )  const [inline]

Gets the GateXoff value.

Returns:
the current GateXoff.

Definition at line 264 of file CigiBaseSensorResp.h.

References GateXoff.

00264 { return(GateXoff); }

float CigiBaseSensorResp::GetGateYoff ( void   )  const [inline]

Gets the GateYoff value.

Returns:
the current GateYoff.

Definition at line 281 of file CigiBaseSensorResp.h.

References GateYoff.

00281 { return(GateYoff); }

Cigi_uint8 CigiBaseSensorResp::GetSensorID ( void   )  const [inline]

Gets the SensorID value.

Returns:
the current SensorID.

Definition at line 184 of file CigiBaseSensorResp.h.

References SensorID.

00184 { return(SensorID); }

SensorStatGrp CigiBaseSensorResp::GetSensorStat ( void   )  const [inline]

Gets the SensorStat value.

Returns:
the current SensorStat.

Definition at line 205 of file CigiBaseSensorResp.h.

References SensorStat.

00205 { return(SensorStat); }

virtual int CigiBaseSensorResp::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 CigiSensorRespV1, CigiSensorRespV2, CigiSensorRespV3, and CigiSensorXRespV3.

int CigiBaseSensorResp::SetGateSzX ( const Cigi_uint16  GateSzXIn,
bool  bndchk = true 
) [inline]

Sets the GateSzX with bound checking control

Parameters:
GateSzXIn - Gate Size along the X axis
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 217 of file CigiBaseSensorResp.h.

References CIGI_SUCCESS, and GateSzX.

00218    {
00219       GateSzX = GateSzXIn;
00220       return(CIGI_SUCCESS);
00221    }

int CigiBaseSensorResp::SetGateSzY ( const Cigi_uint16  GateSzYIn,
bool  bndchk = true 
) [inline]

Sets the GateSzY with bound checking control

Parameters:
GateSzYIn - Gate Size along the Y axis
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 238 of file CigiBaseSensorResp.h.

References CIGI_SUCCESS, and GateSzY.

00239    {
00240       GateSzY = GateSzYIn;
00241       return(CIGI_SUCCESS);
00242    }

int CigiBaseSensorResp::SetGateXoff ( const float  GateXoffIn,
bool  bndchk = true 
)

Sets the GateXoff with bound checking control

Parameters:
GateXoffIn - The Gate offset angle along the X axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 130 of file CigiBaseSensorResp.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and GateXoff.

00131 {
00132 
00133 #ifndef CIGI_NO_BND_CHK
00134    if(bndchk && ((GateXoffIn < -180.0)||(GateXoffIn > 180.0)))
00135    {
00136 #ifndef CIGI_NO_EXCEPT
00137       throw CigiValueOutOfRangeException("GateXoff",(float)GateXoffIn,-180.0,180.0);
00138 #endif
00139       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00140    }
00141 #endif
00142 
00143    GateXoff = GateXoffIn;
00144    return(CIGI_SUCCESS);
00145 
00146 }

int CigiBaseSensorResp::SetGateYoff ( const float  GateYoffIn,
bool  bndchk = true 
)

Sets the GateYoff with bound checking control

Parameters:
GateYoffIn - The Gate offset angle along the Y axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 152 of file CigiBaseSensorResp.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and GateYoff.

00153 {
00154 
00155 #ifndef CIGI_NO_BND_CHK
00156    if(bndchk && ((GateYoffIn < -180.0)||(GateYoffIn > 180.0)))
00157    {
00158 #ifndef CIGI_NO_EXCEPT
00159       throw CigiValueOutOfRangeException("GateYoff",(float)GateYoffIn,-180.0,180.0);
00160 #endif
00161       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00162    }
00163 #endif
00164 
00165    GateYoff = GateYoffIn;
00166    return(CIGI_SUCCESS);
00167 
00168 }

int CigiBaseSensorResp::SetSensorID ( const Cigi_uint8  SensorIDIn,
bool  bndchk = true 
) [inline]

Sets the SensorID with bound checking control

Parameters:
SensorIDIn - Sensor 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 175 of file CigiBaseSensorResp.h.

References CIGI_SUCCESS, and SensorID.

00176    {
00177       SensorID = SensorIDIn;
00178       return(CIGI_SUCCESS);
00179    }

int CigiBaseSensorResp::SetSensorStat ( const SensorStatGrp  SensorStatIn,
bool  bndchk = true 
)

Sets the SensorStat with bound checking control

Parameters:
SensorStatIn - Sensor State/Status
Searching=0
Tracking=1
NearBrakeLock=2
BrakeLock=3
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 108 of file CigiBaseSensorResp.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and SensorStat.

00109 {
00110 
00111 #ifndef CIGI_NO_BND_CHK
00112    if(bndchk && ((SensorStatIn < 0)||(SensorStatIn > 3)))
00113    {
00114 #ifndef CIGI_NO_EXCEPT
00115       throw CigiValueOutOfRangeException("SensorStat",(SensorStatGrp)SensorStatIn,0,3);
00116 #endif
00117       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00118    }
00119 #endif
00120 
00121    SensorStat = SensorStatIn;
00122    return(CIGI_SUCCESS);
00123 
00124 }

virtual int CigiBaseSensorResp::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 CigiSensorRespV1, CigiSensorRespV2, CigiSensorRespV3, and CigiSensorXRespV3.

Friends And Related Function Documentation

friend class CigiSensorRespV1 [friend]

Definition at line 86 of file CigiBaseSensorResp.h.

friend class CigiSensorRespV2 [friend]

Definition at line 87 of file CigiBaseSensorResp.h.

friend class CigiSensorRespV3 [friend]

Definition at line 88 of file CigiBaseSensorResp.h.

friend class CigiSensorXRespV3 [friend]

Definition at line 89 of file CigiBaseSensorResp.h.

Member Data Documentation

Cigi_uint16 CigiBaseSensorResp::EntityID [protected]

EntityID
The ID of the entity being tracked

Definition at line 322 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), and CigiSensorXRespV3::Unpack().

bool CigiBaseSensorResp::EntityTgt [protected]

EntityTgt
True if an entity is being tracked

Definition at line 316 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorXRespV3::Unpack(), and CigiSensorRespV3::Unpack().

Cigi_uint32 CigiBaseSensorResp::FrameCntr [protected]

FrameCntr
Frame count

Definition at line 358 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorXRespV3::Unpack(), and CigiSensorRespV3::Unpack().

Cigi_uint16 CigiBaseSensorResp::GateSzX [protected]

GateSzX
The size of the gate in pixels along the horizontal display axis.

Definition at line 329 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetGateSzX(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetGateSzX(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

Cigi_uint16 CigiBaseSensorResp::GateSzY [protected]

GateSzY
The size of the gate in pixels along the vertical display axis.

Definition at line 336 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetGateSzY(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetGateSzY(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

float CigiBaseSensorResp::GateXoff [protected]

GateXoff
The horizontal angle between the view normal and the line from the view projection center and the center of the gate position.

Definition at line 344 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetGateXoff(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetGateXoff(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

float CigiBaseSensorResp::GateYoff [protected]

GateYoff
The horizontal angle between the view normal and the line from the view projection center and the center of the gate position.

Definition at line 352 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetGateYoff(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetGateYoff(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

Cigi_uint8 CigiBaseSensorResp::SensorID [protected]

SensorID
The ID of the sensor being reported.

Definition at line 299 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetSensorID(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetSensorID(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

SensorStatGrp CigiBaseSensorResp::SensorStat [protected]

SensorStat
Sensor State or Status
0-Searching
1-Tracking
2-NearBrakeLock
3-BrakeLock

Definition at line 310 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), GetSensorStat(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), SetSensorStat(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::Unpack().

double CigiBaseSensorResp::TrackPntAlt [protected]

TrackPntAlt
The tracked point's altitude.

Definition at line 376 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), and CigiSensorXRespV3::Unpack().

double CigiBaseSensorResp::TrackPntLat [protected]

TrackPntLat
The tracked point's Latitude.

Definition at line 364 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), CigiSensorXRespV3::SetTrackPntLat(), and CigiSensorXRespV3::Unpack().

double CigiBaseSensorResp::TrackPntLon [protected]

TrackPntLon
The tracked point's Longitude.

Definition at line 370 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), CigiSensorXRespV3::SetTrackPntLon(), and CigiSensorXRespV3::Unpack().

Cigi_uint16 CigiBaseSensorResp::ViewID [protected]

ViewID
The ID of the view currently displaying the sensor scene.

Definition at line 293 of file CigiBaseSensorResp.h.

Referenced by CigiSensorRespV1::CigiSensorRespV1(), CigiSensorRespV2::CigiSensorRespV2(), CigiSensorRespV3::CigiSensorRespV3(), CigiSensorXRespV3::CigiSensorXRespV3(), CigiSensorXRespV3::Pack(), CigiSensorRespV3::Pack(), CigiSensorRespV2::Pack(), CigiSensorRespV1::Pack(), CigiSensorRespV2::SetViewID(), CigiSensorRespV1::SetViewID(), CigiSensorXRespV3::Unpack(), CigiSensorRespV3::Unpack(), CigiSensorRespV2::Unpack(), and CigiSensorRespV1::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