CigiSymbolCloneV3_3 Class Reference

#include <CigiSymbolCloneV3_3.h>

Inheritance diagram for CigiSymbolCloneV3_3:

List of all members.

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

---

Detailed Description

The base class for all packets.

Definition at line 50 of file CigiSymbolCloneV3_3.h.

---

Constructor & Destructor Documentation

CigiSymbolCloneV3_3::CigiSymbolCloneV3_3

(

void

)

General Constructor

Definition at line 56 of file CigiSymbolCloneV3_3.cpp.

References CIGI_SYMBOL_CLONE_PACKET_ID_V3_3, CIGI_SYMBOL_CLONE_PACKET_SIZE_V3_3, CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseSymbolClone::SourceID, CigiBaseSymbolClone::SourceType, CigiBaseSymbolClone::SymbolID, CigiBaseSymbolClone::SymbolSrc, and CigiBasePacket::Version.

{
   PacketID = CIGI_SYMBOL_CLONE_PACKET_ID_V3_3;
   PacketSize = CIGI_SYMBOL_CLONE_PACKET_SIZE_V3_3;
   Version = 3;
   MinorVersion = 3;

   SymbolID = 0;
   SourceType = CigiBaseSymbolClone::SymbolSrc;
   SourceID = 0;

}

CigiSymbolCloneV3_3::~CigiSymbolCloneV3_3

(

void

)

[virtual]

General Destructor

Definition at line 72 of file CigiSymbolCloneV3_3.cpp.

{
}

---

Member Function Documentation

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

A virtual Pack function.

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

Definition at line 85 of file CigiSymbolCloneV3_3.cpp.

References PackPointerUnion::c, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, PackPointerUnion::s, CigiBaseSymbolClone::SourceID, CigiBaseSymbolClone::SourceType, CigiBaseSymbolClone::SymbolID, and CigiBaseSymbolClone::SymbolTemplateSrc.

{
   PackPointer CDta;

   CigiSymbolCloneV3_3 * Data =
      ( CigiSymbolCloneV3_3 *)Base;

   CDta.c = Buff;

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

   *CDta.s++ = Data->SymbolID;

   if(Data->SourceType == CigiBaseSymbolClone::SymbolTemplateSrc)
      *CDta.c++ = 0x01;
   else
      *CDta.c++ = 0;

   *CDta.c++ = 0;

   *CDta.s++ = Data->SourceID;

   return(PacketSize);

}

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

A virtual Unpack function.

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

Definition at line 115 of file CigiSymbolCloneV3_3.cpp.

References PackPointerUnion::c, CigiSwap2(), CigiBasePacket::PacketSize, PackPointerUnion::s, CigiBaseSymbolClone::SourceID, CigiBaseSymbolClone::SourceType, and CigiBaseSymbolClone::SymbolID.

{
   PackPointer CDta;
   unsigned char HDta = 0;

   CDta.c = Buff;

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

   if(!Swap)
   {

      SymbolID = *CDta.s++;

      HDta = *CDta.c++;

      CDta.c++;

      SourceID = *CDta.s++;

   }
   else
   {

      CigiSwap2(&SymbolID, CDta.s++);

      HDta = *CDta.c++;

      CDta.c++;

      CigiSwap2(&SourceID, CDta.s++);

   }

   SourceType = (CigiBaseSymbolClone::SymbolSourceGrp)(HDta & 0x01);

   return(PacketSize);

}

---

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

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

---