CigiBaseVariableSizePckt Class Reference

#include <CigiBaseVariableSizePckt.h>

Inheritance diagram for CigiBaseVariableSizePckt:

List of all members.

Public Member Functions
	CigiBaseVariableSizePckt ()
virtual	~CigiBaseVariableSizePckt ()
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	GetTruePacketSize (CigiBaseVariableSizePckt &refPacket)=0
int	GetVariableDataSize (void)
Protected Attributes
int	VariableDataSize

---

Detailed Description

The base class for all packets.

Definition at line 50 of file CigiBaseVariableSizePckt.h.

---

Constructor & Destructor Documentation

CigiBaseVariableSizePckt::CigiBaseVariableSizePckt

(

)

[inline]

General Constructor

Definition at line 57 of file CigiBaseVariableSizePckt.h.

{ };

virtual CigiBaseVariableSizePckt::~CigiBaseVariableSizePckt

(

)

[inline, virtual]

General Destructor

Definition at line 62 of file CigiBaseVariableSizePckt.h.

{ };

---

Member Function Documentation

virtual int CigiBaseVariableSizePckt::GetTruePacketSize

(

CigiBaseVariableSizePckt &

refPacket

)

[pure virtual]

A pure virtual function to determine the size that the packet will take up when packed. This function is not implemented in this class.

Parameters:

refPacket

- A pointer to the current pack point.

Returns:

The size that the packet will take up when packed

Implemented in CigiBaseIGMsg, CigiBaseSymbolCircleDef, CigiBaseSymbolLineDef, CigiBaseSymbolTextDef, CigiIGMsgV2, and CigiIGMsgV3.

Referenced by CigiOutgoingMsg::operator<<().

int CigiBaseVariableSizePckt::GetVariableDataSize

(

void

)

[inline]

An accessor to the size of the variable data.

Returns:

The size of the variable data

Definition at line 106 of file CigiBaseVariableSizePckt.h.

Referenced by CigiIGMsgV3::GetTruePacketSize(), CigiIGMsgV2::GetTruePacketSize(), CigiBaseSymbolTextDef::GetTruePacketSize(), CigiBaseSymbolLineDef::GetTruePacketSize(), and CigiBaseSymbolCircleDef::GetTruePacketSize().

{ return(VariableDataSize); }

virtual int CigiBaseVariableSizePckt::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 CigiBaseIGMsg, CigiBaseSymbolCircleDef, CigiBaseSymbolLineDef, CigiBaseSymbolTextDef, CigiIGMsgV3, CigiSymbolCircleDefV3_3, CigiSymbolLineDefV3_3, and CigiSymbolTextDefV3_3.

Referenced by CigiOutgoingMsg::operator<<().

virtual int CigiBaseVariableSizePckt::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 CigiBaseIGMsg, CigiBaseSymbolCircleDef, CigiBaseSymbolLineDef, CigiBaseSymbolTextDef, CigiIGMsgV3, CigiSymbolCircleDefV3_3, CigiSymbolLineDefV3_3, and CigiSymbolTextDefV3_3.

---

Member Data Documentation

int CigiBaseVariableSizePckt::VariableDataSize [protected]

The current size of the variable data

Definition at line 114 of file CigiBaseVariableSizePckt.h.

Referenced by CigiSymbolCircleDefV3_3::AddCircle(), CigiSymbolLineDefV3_3::AddVertex(), CigiBaseSymbolTextDef::CigiBaseSymbolTextDef(), CigiIGMsgV2::CigiIGMsgV2(), CigiIGMsgV3::CigiIGMsgV3(), CigiSymbolCircleDefV3_3::CigiSymbolCircleDefV3_3(), CigiSymbolLineDefV3_3::CigiSymbolLineDefV3_3(), CigiSymbolTextDefV3_3::CigiSymbolTextDefV3_3(), CigiBaseSymbolCircleDef::ClearCircles(), CigiBaseSymbolLineDef::ClearVertices(), CigiBaseSymbolTextDef::GetTextSize(), CigiSymbolLineDefV3_3::operator=(), CigiSymbolCircleDefV3_3::operator=(), CigiBaseSymbolTextDef::operator=(), CigiSymbolTextDefV3_3::Pack(), CigiSymbolLineDefV3_3::Pack(), CigiSymbolCircleDefV3_3::Pack(), CigiSymbolCircleDefV3_3::RemoveCircle(), CigiSymbolLineDefV3_3::RemoveVertex(), CigiIGMsgV3::SetMsg(), CigiIGMsgV2::SetMsg(), CigiBaseSymbolTextDef::SetText(), CigiSymbolTextDefV3_3::Unpack(), CigiSymbolLineDefV3_3::Unpack(), and CigiSymbolCircleDefV3_3::Unpack().

---

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

• ccl/include/CigiBaseVariableSizePckt.h

---