CigiCollDetVolRespV3 Class Reference

#include <CigiCollDetVolRespV3.h>

Inheritance diagram for CigiCollDetVolRespV3:

List of all members.

Public Member Functions
	CigiCollDetVolRespV3 ()
virtual	~CigiCollDetVolRespV3 ()
virtual int	Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int	Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)
int	SetVolID (const Cigi_uint8 VolIDIn, bool bndchk=true)
Cigi_uint8	GetVolID (void) const
int	SetCollVolID (const Cigi_uint8 CollVolIDIn, bool bndchk=true)
Cigi_uint8	GetCollVolID (void) const

---

Detailed Description

Definition at line 58 of file CigiCollDetVolRespV3.h.

---

Constructor & Destructor Documentation

CigiCollDetVolRespV3::CigiCollDetVolRespV3

(

)

General Constructor

Definition at line 67 of file CigiCollDetVolRespV3.cpp.

References CIGI_COLL_DET_VOL_RESP_PACKET_ID_V3, CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V3, CigiBaseCollDetVolResp::CollEntityID, CigiBaseCollDetVolResp::CollType, CigiBaseCollDetVolResp::CollVolID, CigiBaseCollDetVolResp::EntityID, CigiBasePacket::MinorVersion, CigiBaseCollDetVolResp::NonEntity, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBasePacket::Version, and CigiBaseCollDetVolResp::VolID.

{

   PacketID = CIGI_COLL_DET_VOL_RESP_PACKET_ID_V3;
   PacketSize = CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V3;
   Version = 3;
   MinorVersion = 0;

   EntityID = 0;
   VolID = 0;
   CollType = NonEntity;
   CollEntityID = 0;
   CollVolID = 0;

}

CigiCollDetVolRespV3::~CigiCollDetVolRespV3

(

)

[virtual]

General Destructor

Definition at line 86 of file CigiCollDetVolRespV3.cpp.

{

}

---

Member Function Documentation

Cigi_uint8 CigiCollDetVolRespV3::GetCollVolID

(

void

)

const [inline]

Gets the CollVolID value.

Returns:

the current CollVolID.

Definition at line 146 of file CigiCollDetVolRespV3.h.

{ return(CollVolID); }

Cigi_uint8 CigiCollDetVolRespV3::GetVolID

(

void

)

const [inline]

Gets the VolID value.

Returns:

the current VolID.

Definition at line 125 of file CigiCollDetVolRespV3.h.

{ return(VolID); }

int CigiCollDetVolRespV3::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 CigiBaseCollDetVolResp.

Definition at line 98 of file CigiCollDetVolRespV3.cpp.

References PackPointerUnion::c, CigiBaseCollDetVolResp::CollEntityID, CigiBaseCollDetVolResp::CollType, CigiBaseCollDetVolResp::CollVolID, CigiBaseCollDetVolResp::EntityID, PackPointerUnion::l, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, PackPointerUnion::s, and CigiBaseCollDetVolResp::VolID.

{
   PackPointer CDta;

   CigiBaseCollDetVolResp * Data = ( CigiBaseCollDetVolResp *)Base;

   CDta.c = Buff;

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

   *CDta.s++ = Data->EntityID;
   *CDta.c++ = Data->VolID;
   *CDta.c++ = (Cigi_uint8)(Data->CollType & 0x01);
   *CDta.s++ = Data->CollEntityID;
   *CDta.c++ = Data->CollVolID;
   *CDta.c++ = 0;
   *CDta.s++ = 0;
   *CDta.l++ = 0;

   return(PacketSize);

}

int CigiCollDetVolRespV3::SetCollVolID	(	const Cigi_uint8	CollVolIDIn,
		bool	bndchk = true
	)			[inline]

Sets the CollVolID with bound checking control

Parameters:

	CollVolIDIn	-
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:

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

Definition at line 137 of file CigiCollDetVolRespV3.h.

References CIGI_SUCCESS.

   {
      CollVolID = CollVolIDIn;
      return(CIGI_SUCCESS);
   }

int CigiCollDetVolRespV3::SetVolID	(	const Cigi_uint8	VolIDIn,
		bool	bndchk = true
	)			[inline]

Sets the VolID with bound checking control

Parameters:

	VolIDIn	-
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:

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

Definition at line 116 of file CigiCollDetVolRespV3.h.

References CIGI_SUCCESS.

   {
      VolID = VolIDIn;
      return(CIGI_SUCCESS);
   }

int CigiCollDetVolRespV3::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 CigiBaseCollDetVolResp.

Definition at line 125 of file CigiCollDetVolRespV3.cpp.

References PackPointerUnion::c, CigiSwap2(), CigiBaseCollDetVolResp::CollEntityID, CigiBaseCollDetVolResp::CollType, CigiBaseCollDetVolResp::CollVolID, CigiBaseCollDetVolResp::EntityID, CigiBasePacket::PacketSize, PackPointerUnion::s, and CigiBaseCollDetVolResp::VolID.

{
   PackPointer CDta;

   CDta.c = Buff;

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

   if(!Swap)
   {
      EntityID = *CDta.s++;
      VolID = *CDta.c++;
      CollType = (CollTypeGrp)(*CDta.c++ & 0x01);
      CollEntityID = *CDta.s++;
      CollVolID = *CDta.c++;
   }
   else
   {
      CigiSwap2(&EntityID, CDta.s++);
      VolID = *CDta.c++;
      CollType = (CollTypeGrp)(*CDta.c++ & 0x01);
      CigiSwap2(&CollEntityID, CDta.s++);
      CollVolID = *CDta.c++;
   }

   return(PacketSize);

}

---

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

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

---