CigiEventNotificationV3 Class Reference

#include <CigiEventNotificationV3.h>

Inheritance diagram for CigiEventNotificationV3:

List of all members.

Public Member Functions
	CigiEventNotificationV3 ()
virtual	~CigiEventNotificationV3 ()
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 CigiEventNotificationV3.h.

---

Constructor & Destructor Documentation

CigiEventNotificationV3::CigiEventNotificationV3

(

)

General Constructor

Definition at line 67 of file CigiEventNotificationV3.cpp.

References CIGI_EVENT_NOTIFICATION_PACKET_ID_V3, CIGI_EVENT_NOTIFICATION_PACKET_SIZE_V3, CigiBaseEventNotification::EventData, CigiBaseEventNotification::EventID, CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseEventNotification::EventDataGrp::ul, and CigiBasePacket::Version.

{

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

   EventID = 0;
   EventData.ul[0] = 0;
   EventData.ul[1] = 0;
   EventData.ul[2] = 0;

}

CigiEventNotificationV3::~CigiEventNotificationV3

(

)

[virtual]

General Destructor

Definition at line 85 of file CigiEventNotificationV3.cpp.

{

}

---

Member Function Documentation

int CigiEventNotificationV3::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 CigiBaseEventNotification.

Definition at line 97 of file CigiEventNotificationV3.cpp.

References PackPointerUnion::c, CigiBaseEventNotification::EventData, CigiBaseEventNotification::EventID, CigiBaseEventNotification::EventDataGrp::l, PackPointerUnion::l, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, and PackPointerUnion::s.

{
   PackPointer CDta;

   CigiBaseEventNotification * Data = ( CigiBaseEventNotification *)Base;

   CDta.c = Buff;

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

   *CDta.s++ = Data->EventID;
   *CDta.l++ = Data->EventData.l[0];
   *CDta.l++ = Data->EventData.l[1];
   *CDta.l++ = Data->EventData.l[2];

   return(PacketSize);

}

int CigiEventNotificationV3::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 CigiBaseEventNotification.

Definition at line 120 of file CigiEventNotificationV3.cpp.

References PackPointerUnion::c, CigiSwap2(), CigiSwap4(), CigiBaseEventNotification::EventData, CigiBaseEventNotification::EventID, PackPointerUnion::l, CigiBaseEventNotification::EventDataGrp::l, CigiBasePacket::PacketSize, and PackPointerUnion::s.

{
   PackPointer CDta;

   CDta.c = Buff;

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

   if(!Swap)
   {
      EventID = *CDta.s++;
      EventData.l[0] = *CDta.l++;
      EventData.l[1] = *CDta.l++;
      EventData.l[2] = *CDta.l++;
   }
   else
   {
      CigiSwap2(&EventID, CDta.s++);
      CigiSwap4(&EventData.l[0], CDta.l++);
      CigiSwap4(&EventData.l[1], CDta.l++);
      CigiSwap4(&EventData.l[2], CDta.l++);
   }

   return(PacketSize);

}

---

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

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

---