CigiDefaultPacket Class Reference

#include <CigiDefaultPacket.h>

Inheritance diagram for CigiDefaultPacket:

List of all members.

Public Member Functions
	CigiDefaultPacket ()
virtual	~CigiDefaultPacket ()
virtual int	Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int	Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)
Cigi_uint8 *	GetDataPtr (void)
Protected Attributes
Cigi_uint8 *	DataPtr

---

Detailed Description

The basic class for a default or unimplemented packet

Definition at line 54 of file CigiDefaultPacket.h.

---

Constructor & Destructor Documentation

CigiDefaultPacket::CigiDefaultPacket

(

)

General Constructor

Definition at line 61 of file CigiDefaultPacket.cpp.

References CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, and CigiBasePacket::Version.

{

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

}

CigiDefaultPacket::~CigiDefaultPacket

(

)

[virtual]

General Destructor

Definition at line 74 of file CigiDefaultPacket.cpp.

{

}

---

Member Function Documentation

Cigi_uint8* CigiDefaultPacket::GetDataPtr

(

void

)

[inline]

Gets a pointer to the packet data.

Returns:

A pointer to the beginning of the packet's data.

Definition at line 109 of file CigiDefaultPacket.h.

{ return(DataPtr); }

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

The virtual Pack function for CIGI 1

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

Definition at line 87 of file CigiDefaultPacket.cpp.

{

   return(0);

}

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

The virtual Unpack function for CIGI 1

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.

Definition at line 99 of file CigiDefaultPacket.cpp.

References DataPtr.

{

   DataPtr = Buff;

   // Get Size
   DataPtr++;
   Cigi_uint8 CurrentSize = *DataPtr;

   return(CurrentSize);

}

---

Member Data Documentation

Cigi_uint8* CigiDefaultPacket::DataPtr [protected]

Data Pointer
A Pointer to the beginning of the packet's data in the message buffer.

Definition at line 121 of file CigiDefaultPacket.h.

Referenced by Unpack().

---

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

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

---