CigiIGMsgV3 Class Reference

#include <CigiIGMsgV3.h>

Inheritance diagram for CigiIGMsgV3:

List of all members.

Public Member Functions
	CigiIGMsgV3 ()
virtual	~CigiIGMsgV3 ()
virtual int	Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int	Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)
virtual int	GetTruePacketSize (CigiBaseVariableSizePckt &refPacket)
int	SetMsg (const Cigi_Ascii *MsgIn, bool bndchk=true)

---

Detailed Description

Definition at line 59 of file CigiIGMsgV3.h.

---

Constructor & Destructor Documentation

CigiIGMsgV3::CigiIGMsgV3

(

)

General Constructor

Definition at line 72 of file CigiIGMsgV3.cpp.

References CIGI_IG_MSG_PACKET_ID_V3, CigiBasePacket::MinorVersion, CigiBaseIGMsg::Msg, CigiBaseIGMsg::MsgID, CigiBaseIGMsg::MsgLen, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseVariableSizePckt::VariableDataSize, and CigiBasePacket::Version.

{

   PacketID = CIGI_IG_MSG_PACKET_ID_V3;
   Version = 3;
   MinorVersion = 0;

   MsgID = 0;

   VariableDataSize = MsgLen = 4;
   memset(Msg,0,4);
   PacketSize = 8;

}

CigiIGMsgV3::~CigiIGMsgV3

(

)

[virtual]

General Destructor

Definition at line 90 of file CigiIGMsgV3.cpp.

{

}

---

Member Function Documentation

int CigiIGMsgV3::GetTruePacketSize

(

CigiBaseVariableSizePckt &

refPacket

)

[virtual]

A virtual function to determine the size that the packet will take up when packed.

Parameters:

refPacket

- A pointer to the current pack point.

Returns:

The size that the packet will take up when packed

Implements CigiBaseIGMsg.

Definition at line 172 of file CigiIGMsgV3.cpp.

References CigiBaseVariableSizePckt::GetVariableDataSize().

{
   return(refPacket.GetVariableDataSize() + 4);
}

int CigiIGMsgV3::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 CigiBaseIGMsg.

Definition at line 102 of file CigiIGMsgV3.cpp.

References PackPointerUnion::c, CigiBaseIGMsg::Msg, CigiBaseIGMsg::MsgID, CigiBaseIGMsg::MsgLen, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, and PackPointerUnion::s.

{

   PackPointer CDta;

   CigiBaseIGMsg * Data = ( CigiBaseIGMsg *)Base;

   CDta.c = Buff;

   *CDta.c++ = PacketID;
   *CDta.c++ = Data->PacketSize;

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

   memcpy(CDta.c,Data->Msg,Data->MsgLen);

   return(Data->PacketSize);

}

int CigiIGMsgV3::SetMsg	(	const Cigi_Ascii *	MsgIn,
		bool	bndchk = true
	)

Sets the Msg with bound checking control

Parameters:

	MsgIn	- Message string
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:

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

Definition at line 187 of file CigiIGMsgV3.cpp.

References CIGI_SUCCESS, CigiBaseIGMsg::Msg, CigiBaseIGMsg::MsgLen, CigiBasePacket::PacketSize, and CigiBaseVariableSizePckt::VariableDataSize.

{

   MsgLen = strlen(MsgIn);

   if(MsgLen == 0)
   {
      MsgLen = 4;
      memset(Msg,0,4);
   }
   else if(MsgLen >= 99)
   {
      MsgLen = 100;
      memcpy(Msg,MsgIn,99);
      Msg[99] = 0;
   }
   else
   {
      memcpy(Msg,MsgIn,MsgLen);

      int tadj = (MsgLen + 5) % 8;

      tadj = (tadj == 0) ? 1 : (9 - tadj);

      memset(&Msg[MsgLen],0,tadj);

      MsgLen += tadj;
   }

   VariableDataSize = MsgLen;
   PacketSize = VariableDataSize + 4;

   return(CIGI_SUCCESS);
}

int CigiIGMsgV3::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 CigiBaseIGMsg.

Definition at line 125 of file CigiIGMsgV3.cpp.

References PackPointerUnion::c, CigiSwap2(), CigiBaseIGMsg::Msg, CigiBaseIGMsg::MsgID, CigiBaseIGMsg::MsgLen, CigiBasePacket::PacketSize, and PackPointerUnion::s.

{

   PackPointer CDta;


   int tPktSz;

   CDta.c = Buff;

   CDta.c++;  // Step over packet id

   tPktSz = *CDta.c++;  // Get packet size

   if(!Swap)
      MsgID = *CDta.s++;
   else
      CigiSwap2(&MsgID, CDta.s++);

   if(tPktSz > 104)
   {
      PacketSize = 104;
      memcpy(&Msg,CDta.c,99);
      Msg[99] = 0;
   }
   else if(tPktSz <= 5)
   {
      PacketSize = tPktSz;
      Msg[0] = 0;
   }
   else
   {
      PacketSize = tPktSz;
      memcpy(&Msg,CDta.c,(tPktSz - 4));
      Msg[(tPktSz - 5)] = 0;
   }

   MsgLen = PacketSize - 4;

   return(tPktSz);

}

---

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

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

---