CigiMaritimeSurfaceRespV3 Class Reference

#include <CigiMaritimeSurfaceRespV3.h>

Inheritance diagram for CigiMaritimeSurfaceRespV3:

List of all members.

Public Member Functions
	CigiMaritimeSurfaceRespV3 ()
virtual	~CigiMaritimeSurfaceRespV3 ()
virtual int	Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int	Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)

---

Detailed Description

Definition at line 57 of file CigiMaritimeSurfaceRespV3.h.

---

Constructor & Destructor Documentation

CigiMaritimeSurfaceRespV3::CigiMaritimeSurfaceRespV3

(

)

General Constructor

Definition at line 67 of file CigiMaritimeSurfaceRespV3.cpp.

References CIGI_MARITIME_SURFACE_RESP_PACKET_ID_V3, CIGI_MARITIME_SURFACE_RESP_PACKET_SIZE_V3, CigiBaseMaritimeSurfaceResp::Clarity, CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseMaritimeSurfaceResp::RequestID, CigiBaseMaritimeSurfaceResp::SurfaceHeight, CigiBasePacket::Version, and CigiBaseMaritimeSurfaceResp::WaterTemp.

{

   PacketID = CIGI_MARITIME_SURFACE_RESP_PACKET_ID_V3;
   PacketSize = CIGI_MARITIME_SURFACE_RESP_PACKET_SIZE_V3;
   Version = 3;
   MinorVersion = 0;

   RequestID = 0;
   SurfaceHeight = 0.0;
   WaterTemp = 0.0;
   Clarity = 0.0;

}

CigiMaritimeSurfaceRespV3::~CigiMaritimeSurfaceRespV3

(

)

[virtual]

General Destructor

Definition at line 85 of file CigiMaritimeSurfaceRespV3.cpp.

{

}

---

Member Function Documentation

int CigiMaritimeSurfaceRespV3::Pack	(	CigiBasePacket *	Base,
		Cigi_uint8 *	Buff,
		void *	Spec
	)			const [virtual]

The virtual Pack function for CIGI 3

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 - This is not used in this class.

Returns:

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

Implements CigiBaseMaritimeSurfaceResp.

Definition at line 97 of file CigiMaritimeSurfaceRespV3.cpp.

References PackPointerUnion::c, CigiBaseMaritimeSurfaceResp::Clarity, PackPointerUnion::f, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseMaritimeSurfaceResp::RequestID, CigiBaseMaritimeSurfaceResp::SurfaceHeight, and CigiBaseMaritimeSurfaceResp::WaterTemp.

{
   PackPointer CDta;

   CigiBaseMaritimeSurfaceResp * Data = ( CigiBaseMaritimeSurfaceResp *)Base;

   CDta.c = Buff;

   *CDta.c++ = PacketID;
   *CDta.c++ = PacketSize;

   *CDta.c++ = Data->RequestID;

   *CDta.c++ = 0;

   *CDta.f++ = Data->SurfaceHeight;
   *CDta.f++ = Data->WaterTemp;
   *CDta.f++ = Data->Clarity;

   return(PacketSize);

}

int CigiMaritimeSurfaceRespV3::Unpack	(	Cigi_uint8 *	Buff,
		bool	Swap,
		void *	Spec
	)			[virtual]

The virtual Unpack function for CIGI 3

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 CigiBaseMaritimeSurfaceResp.

Definition at line 123 of file CigiMaritimeSurfaceRespV3.cpp.

References PackPointerUnion::c, CigiSwap4(), CigiBaseMaritimeSurfaceResp::Clarity, PackPointerUnion::f, CigiBasePacket::PacketSize, CigiBaseMaritimeSurfaceResp::RequestID, CigiBaseMaritimeSurfaceResp::SurfaceHeight, and CigiBaseMaritimeSurfaceResp::WaterTemp.

{
   PackPointer CDta;

   CDta.c = Buff;

   CDta.c += 2;  // Step over packet id and size

   RequestID = *CDta.c++;

   CDta.c++;

   if(!Swap)
   {
      SurfaceHeight = *CDta.f++;
      WaterTemp = *CDta.f++;
      Clarity = *CDta.f++;
   }
   else
   {
      CigiSwap4(&SurfaceHeight, CDta.f++);
      CigiSwap4(&WaterTemp, CDta.f++);
      CigiSwap4(&Clarity, CDta.f++);
   }

   return(PacketSize);

}

---

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

• ccl/include/CigiMaritimeSurfaceRespV3.h
• ccl/source/CigiMaritimeSurfaceRespV3.cpp

---