CigiIGMsgV2 Class Reference

#include <CigiIGMsgV2.h>

Inheritance diagram for CigiIGMsgV2:

List of all members.

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

---

Detailed Description

Definition at line 58 of file CigiIGMsgV2.h.

---

Constructor & Destructor Documentation

CigiIGMsgV2::CigiIGMsgV2

(

)

General Constructor

Definition at line 87 of file CigiIGMsgV2.cpp.

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

{

   PacketID = CIGI_IG_MSG_PACKET_ID_V2;
   PacketSize = 8;
   Version = 2;
   MinorVersion = 0;

   MsgID = 0;
   memset(Msg,0,4);
   VariableDataSize = MsgLen = 4;

}

CigiIGMsgV2::~CigiIGMsgV2

(

)

[virtual]

General Destructor

Definition at line 104 of file CigiIGMsgV2.cpp.

{

}

---

Member Function Documentation

int CigiIGMsgV2::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 187 of file CigiIGMsgV2.cpp.

References CigiBaseVariableSizePckt::GetVariableDataSize().

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

virtual int CigiIGMsgV2::Pack	(	CigiBasePacket *	Base,
		unsigned char *	Buff,
		void *	Spec
	)			const [virtual]

The virtual Pack function for CIGI 2

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

int CigiIGMsgV2::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 202 of file CigiIGMsgV2.cpp.

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

{

   MsgLen = strlen(MsgIn);

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

      int tadj = (MsgLen + 1) % 4;

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

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

      MsgLen += tadj;
   }

   VariableDataSize = MsgLen;
   PacketSize = VariableDataSize + 4;

   return(CIGI_SUCCESS);
}

virtual int CigiIGMsgV2::Unpack	(	unsigned char *	Buff,
		bool	Swap,
		void *	Spec
	)			[virtual]

The virtual Unpack function for CIGI 2

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

---

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

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

---