CigiBaseTerrestrialSurfaceResp Class Reference

#include <CigiBaseTerrestrialSurfaceResp.h>

Inheritance diagram for CigiBaseTerrestrialSurfaceResp:

List of all members.

Public Member Functions
	CigiBaseTerrestrialSurfaceResp ()
virtual	~CigiBaseTerrestrialSurfaceResp ()
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	SetRequestID (const Cigi_uint8 RequestIDIn, bool bndchk=true)
Cigi_uint8	GetRequestID (void) const
int	SetSurfaceConditionID (const Cigi_uint32 SurfaceConditionIDIn, bool bndchk=true)
Cigi_uint32	GetSurfaceConditionID (void) const
Protected Attributes
Cigi_uint8	RequestID
Cigi_uint32	SurfaceConditionID
Friends
class	CigiTerrestrialSurfaceRespV3

---

Detailed Description

Definition at line 71 of file CigiBaseTerrestrialSurfaceResp.h.

---

Constructor & Destructor Documentation

CigiBaseTerrestrialSurfaceResp::CigiBaseTerrestrialSurfaceResp

(

)

[inline]

General Constructor

Definition at line 83 of file CigiBaseTerrestrialSurfaceResp.h.

{ };

virtual CigiBaseTerrestrialSurfaceResp::~CigiBaseTerrestrialSurfaceResp

(

)

[inline, virtual]

General Destructor

Definition at line 88 of file CigiBaseTerrestrialSurfaceResp.h.

{ };

---

Member Function Documentation

virtual int CigiBaseTerrestrialSurfaceResp::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 131 of file CigiBaseTerrestrialSurfaceResp.h.

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

   {
      // V1 & V2 use the same packet id number
      if(CnvtVersion.CigiMajorVersion < 3)
      {
         CnvtInfo.ProcID = CigiProcessType::ProcNone;
         CnvtInfo.CnvtPacketID = 0;
      }
      else
      {
         CnvtInfo.ProcID = CigiProcessType::ProcStd;
         CnvtInfo.CnvtPacketID = CIGI_TERRESTRIAL_SURFACE_RESP_PACKET_ID_V3;
      }

      return(CIGI_SUCCESS);
   }

Cigi_uint8 CigiBaseTerrestrialSurfaceResp::GetRequestID

(

void

)

const [inline]

Gets the RequestID value.

Returns:

the current RequestID.

Definition at line 171 of file CigiBaseTerrestrialSurfaceResp.h.

References RequestID.

{ return(RequestID); }

Cigi_uint32 CigiBaseTerrestrialSurfaceResp::GetSurfaceConditionID

(

void

)

const [inline]

Gets the SurfaceConditionID value.

Returns:

the current SurfaceConditionID.

Definition at line 192 of file CigiBaseTerrestrialSurfaceResp.h.

References SurfaceConditionID.

{ return(SurfaceConditionID); }

virtual int CigiBaseTerrestrialSurfaceResp::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 CigiTerrestrialSurfaceRespV3.

int CigiBaseTerrestrialSurfaceResp::SetRequestID	(	const Cigi_uint8	RequestIDIn,
		bool	bndchk = true
	)			[inline]

Sets the RequestID with bound checking control

Parameters:

	RequestIDIn	- 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 162 of file CigiBaseTerrestrialSurfaceResp.h.

References CIGI_SUCCESS, and RequestID.

   {
      RequestID = RequestIDIn;
      return(CIGI_SUCCESS);
   }

int CigiBaseTerrestrialSurfaceResp::SetSurfaceConditionID	(	const Cigi_uint32	SurfaceConditionIDIn,
		bool	bndchk = true
	)			[inline]

Sets the SurfaceConditionID with bound checking control

Parameters:

	SurfaceConditionIDIn	- Surface Condition ID code
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 183 of file CigiBaseTerrestrialSurfaceResp.h.

References CIGI_SUCCESS, and SurfaceConditionID.

   {
      SurfaceConditionID = SurfaceConditionIDIn;
      return(CIGI_SUCCESS);
   }

virtual int CigiBaseTerrestrialSurfaceResp::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 CigiTerrestrialSurfaceRespV3.

---

Friends And Related Function Documentation

friend class CigiTerrestrialSurfaceRespV3 [friend]

Definition at line 74 of file CigiBaseTerrestrialSurfaceResp.h.

---

Member Data Documentation

Cigi_uint8 CigiBaseTerrestrialSurfaceResp::RequestID [protected]

RequestID
Request ID

Definition at line 204 of file CigiBaseTerrestrialSurfaceResp.h.

Referenced by CigiTerrestrialSurfaceRespV3::CigiTerrestrialSurfaceRespV3(), GetRequestID(), CigiTerrestrialSurfaceRespV3::Pack(), SetRequestID(), and CigiTerrestrialSurfaceRespV3::Unpack().

Cigi_uint32 CigiBaseTerrestrialSurfaceResp::SurfaceConditionID [protected]

SurfaceConditionID
Surface Condition ID code

Definition at line 210 of file CigiBaseTerrestrialSurfaceResp.h.

Referenced by CigiTerrestrialSurfaceRespV3::CigiTerrestrialSurfaceRespV3(), GetSurfaceConditionID(), CigiTerrestrialSurfaceRespV3::Pack(), SetSurfaceConditionID(), and CigiTerrestrialSurfaceRespV3::Unpack().

---

The documentation for this class was generated from the following file:

• ccl/include/CigiBaseTerrestrialSurfaceResp.h

---