CigiCollDetVolRespV2 Class Reference

#include <CigiCollDetVolRespV2.h>

Inheritance diagram for CigiCollDetVolRespV2:

List of all members.

Public Member Functions
	CigiCollDetVolRespV2 ()
virtual	~CigiCollDetVolRespV2 ()
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

---

Detailed Description

Definition at line 57 of file CigiCollDetVolRespV2.h.

---

Constructor & Destructor Documentation

CigiCollDetVolRespV2::CigiCollDetVolRespV2

(

)

General Constructor

Definition at line 82 of file CigiCollDetVolRespV2.cpp.

References CIGI_COLL_DET_VOL_RESP_PACKET_ID_V2, CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2, 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_V2;
   PacketSize = CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2;
   Version = 2;
   MinorVersion = 0;

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

}

CigiCollDetVolRespV2::~CigiCollDetVolRespV2

(

)

[virtual]

General Destructor

Definition at line 101 of file CigiCollDetVolRespV2.cpp.

{

}

---

Member Function Documentation

Cigi_uint8 CigiCollDetVolRespV2::GetVolID

(

void

)

const [inline]

Gets the VolID value.

Returns:

the current VolID.

Definition at line 120 of file CigiCollDetVolRespV2.h.

{ return(VolID); }

int CigiCollDetVolRespV2::Pack	(	CigiBasePacket *	Base,
		Cigi_uint8 *	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

Implements CigiBaseCollDetVolResp.

Definition at line 113 of file CigiCollDetVolRespV2.cpp.

References PackPointerUnion::c, CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2, CIGI_SCOPY2, CigiBaseCollDetVolResp::CollEntityID, CigiBaseCollDetVolResp::CollType, PackPointerUnion::d, CigiBaseCollDetVolResp::EntityID, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, PackPointerUnion::s, and CigiBaseCollDetVolResp::VolID.

{
   double DBuf[6];

   Cigi_uint8 *tBuf = (Cigi_uint8 *)DBuf;

   PackPointer CDta;

   CigiBaseCollDetVolResp * Data = ( CigiBaseCollDetVolResp *)Base;

   CDta.d = DBuf;

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

   CIGI_SCOPY2(CDta.s++, &Data->EntityID);

   Cigi_uint8 HDta = (Data->VolID << 1) & 0xfe;
   HDta |= (Cigi_uint16)(Data->CollType & 0x01);
   *CDta.c++ = HDta;

   *CDta.c++ = 0;

   CIGI_SCOPY2(CDta.s++, &Data->CollEntityID);

   memcpy(Buff,tBuf,CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2);

   return(PacketSize);

}

int CigiCollDetVolRespV2::SetVolID	(	const Cigi_uint8	VolIDIn,
		bool	bndchk = true
	)

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 185 of file CigiCollDetVolRespV2.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and CigiBaseCollDetVolResp::VolID.

{

#ifndef CIGI_NO_BND_CHK
   if(bndchk && ((VolIDIn < 0)||(VolIDIn > 127)))
   {
#ifndef CIGI_NO_EXCEPT
      throw CigiValueOutOfRangeException("VolID",(Cigi_uint8)VolIDIn,0,127);
#endif
      return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
   }
#endif

   VolID = VolIDIn;
   return(CIGI_SUCCESS);

}

int CigiCollDetVolRespV2::Unpack	(	Cigi_uint8 *	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

Implements CigiBaseCollDetVolResp.

Definition at line 147 of file CigiCollDetVolRespV2.cpp.

References PackPointerUnion::c, CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2, CIGI_SCOPY2, CigiBaseCollDetVolResp::CollEntityID, CigiBaseCollDetVolResp::CollType, PackPointerUnion::d, CigiBaseCollDetVolResp::EntityID, CigiBasePacket::PacketSize, PackPointerUnion::s, and CigiBaseCollDetVolResp::VolID.

{
   double DBuf[6];

   Cigi_uint8 *tBuf = (Cigi_uint8 *)DBuf;

   PackPointer CDta;

   memcpy(tBuf,Buff,CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2);

   CDta.d = DBuf;

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

   CIGI_SCOPY2(&EntityID, CDta.s++);

   Cigi_uint8 HDta = *CDta.c++;
   VolID = (HDta >> 1) & 0x7f;
   CollType = (CollTypeGrp)(HDta & 0x01);

   CDta.c++;

   CIGI_SCOPY2(&CollEntityID, CDta.s++);

   return(PacketSize);

}

---

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

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

---