CigiBaseCollDetVolResp Class Reference

#include <CigiBaseCollDetVolResp.h>

Inheritance diagram for CigiBaseCollDetVolResp:

CigiBasePacket CigiCollDetVolRespV2 CigiCollDetVolRespV3 List of all members.

Public Types

 NonEntity = 0
 Entity = 1
enum  CollTypeGrp { NonEntity = 0, Entity = 1 }

Public Member Functions

 CigiBaseCollDetVolResp ()
virtual ~CigiBaseCollDetVolResp ()
virtual int Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0
virtual int GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo)
int SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true)
Cigi_uint16 GetEntityID (void) const
int SetCollType (const CollTypeGrp CollTypeIn, bool bndchk=true)
CollTypeGrp GetCollType (void) const
int SetCollEntityID (const Cigi_uint16 CollEntityIDIn, bool bndchk=true)
Cigi_uint16 GetCollEntityID (void) const

Protected Attributes

Cigi_uint16 EntityID
Cigi_uint8 VolID
CollTypeGrp CollType
Cigi_uint16 CollEntityID
Cigi_uint8 CollVolID

Friends

class CigiCollDetVolRespV2
class CigiCollDetVolRespV3

Detailed Description

Definition at line 75 of file CigiBaseCollDetVolResp.h.

Member Enumeration Documentation

enum CigiBaseCollDetVolResp::CollTypeGrp

The enumeration for the CigiBaseCollDetVolResp Group

Enumerator:
NonEntity 
Entity 

Definition at line 86 of file CigiBaseCollDetVolResp.h.

00087    {
00088       NonEntity=0,
00089       Entity=1
00090    };

Constructor & Destructor Documentation

CigiBaseCollDetVolResp::CigiBaseCollDetVolResp (  ) 

General Constructor

Definition at line 60 of file CigiBaseCollDetVolResp.cpp.

00061 {
00062 
00063 }

CigiBaseCollDetVolResp::~CigiBaseCollDetVolResp (  )  [virtual]

General Destructor

Definition at line 70 of file CigiBaseCollDetVolResp.cpp.

00071 {
00072 
00073 }

Member Function Documentation

int CigiBaseCollDetVolResp::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [virtual]

A virtual Conversion Information function. This function provides conversion information for this packet.

Parameters:
CnvtVersion - The CIGI version to which this packet is being converted.
CnvtInfo - The information needed for conversion
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBasePacket.

Definition at line 84 of file CigiBaseCollDetVolResp.cpp.

References CIGI_COLL_DET_VOL_RESP_PACKET_ID_V2, CIGI_COLL_DET_VOL_RESP_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00086 {
00087    if(CnvtVersion.CigiMajorVersion < 2)
00088    {
00089       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00090       CnvtInfo.CnvtPacketID = 0;
00091    }
00092    else
00093    {
00094       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00095 
00096       if(CnvtVersion.CigiMajorVersion < 3)
00097          CnvtInfo.CnvtPacketID = CIGI_COLL_DET_VOL_RESP_PACKET_ID_V2;
00098       else
00099          CnvtInfo.CnvtPacketID = CIGI_COLL_DET_VOL_RESP_PACKET_ID_V3;
00100    }
00101 
00102    return(CIGI_SUCCESS);
00103 }

Cigi_uint16 CigiBaseCollDetVolResp::GetCollEntityID ( void   )  const [inline]

Gets the CollEntityID value.

Returns:
the current CollEntityID.

Definition at line 212 of file CigiBaseCollDetVolResp.h.

References CollEntityID.

00212 { return(CollEntityID); }

CollTypeGrp CigiBaseCollDetVolResp::GetCollType ( void   )  const [inline]

Gets the CollType value.

Returns:
the current CollType.

Definition at line 191 of file CigiBaseCollDetVolResp.h.

References CollType.

00191 { return(CollType); }

Cigi_uint16 CigiBaseCollDetVolResp::GetEntityID ( void   )  const [inline]

Gets the EntityID value.

Returns:
the current EntityID.

Definition at line 172 of file CigiBaseCollDetVolResp.h.

References EntityID.

00172 { return(EntityID); }

virtual int CigiBaseCollDetVolResp::Pack ( CigiBasePacket *  Base,
Cigi_uint8 *  Buff,
void *  Spec 
) const [pure virtual]

A pure virtual Pack function. This function is not implemented in this class.

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.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiCollDetVolRespV2, and CigiCollDetVolRespV3.

int CigiBaseCollDetVolResp::SetCollEntityID ( const Cigi_uint16  CollEntityIDIn,
bool  bndchk = true 
) [inline]

Sets the CollEntityID with bound checking control

Parameters:
CollEntityIDIn - Entity Collided with
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 203 of file CigiBaseCollDetVolResp.h.

References CIGI_SUCCESS, and CollEntityID.

00204    {
00205       CollEntityID = CollEntityIDIn;
00206       return(CIGI_SUCCESS);
00207    }

int CigiBaseCollDetVolResp::SetCollType ( const CollTypeGrp  CollTypeIn,
bool  bndchk = true 
)

Sets the CollType with bound checking control

Parameters:
CollTypeIn - Collision type
NonEntity=0
Entity=1
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 114 of file CigiBaseCollDetVolResp.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and CollType.

00115 {
00116 
00117 #ifndef CIGI_NO_BND_CHK
00118    if(bndchk && ((CollTypeIn < 0)||(CollTypeIn > 1)))
00119    {
00120 #ifndef CIGI_NO_EXCEPT
00121       throw CigiValueOutOfRangeException("CollType",(CollTypeGrp)CollTypeIn,0,1);
00122 #endif
00123       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00124    }
00125 #endif
00126 
00127    CollType = CollTypeIn;
00128    return(CIGI_SUCCESS);
00129 
00130 }

int CigiBaseCollDetVolResp::SetEntityID ( const Cigi_uint16  EntityIDIn,
bool  bndchk = true 
) [inline]

Sets the EntityID with bound checking control

Parameters:
EntityIDIn - Entity ID
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 163 of file CigiBaseCollDetVolResp.h.

References CIGI_SUCCESS, and EntityID.

00164    {
00165       EntityID = EntityIDIn;
00166       return(CIGI_SUCCESS);
00167    }

virtual int CigiBaseCollDetVolResp::Unpack ( Cigi_uint8 *  Buff,
bool  Swap,
void *  Spec 
) [pure virtual]

A pure virtual Unpack function. This function is not implemented in this class.

Parameters:
Buff - A pointer to the current pack point.
Swap - N/A for V1 & V2
Spec - A pointer to special data.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiCollDetVolRespV2, and CigiCollDetVolRespV3.

Friends And Related Function Documentation

friend class CigiCollDetVolRespV2 [friend]

Definition at line 78 of file CigiBaseCollDetVolResp.h.

friend class CigiCollDetVolRespV3 [friend]

Definition at line 79 of file CigiBaseCollDetVolResp.h.

Member Data Documentation

Cigi_uint16 CigiBaseCollDetVolResp::CollEntityID [protected]

CollEntityID
Entity with which the referance entity collided

Definition at line 245 of file CigiBaseCollDetVolResp.h.

Referenced by CigiCollDetVolRespV2::CigiCollDetVolRespV2(), CigiCollDetVolRespV3::CigiCollDetVolRespV3(), GetCollEntityID(), CigiCollDetVolRespV3::Pack(), CigiCollDetVolRespV2::Pack(), SetCollEntityID(), CigiCollDetVolRespV3::Unpack(), and CigiCollDetVolRespV2::Unpack().

CollTypeGrp CigiBaseCollDetVolResp::CollType [protected]

CollType
Collision Type
0-NonEntity
1-Entity

Definition at line 239 of file CigiBaseCollDetVolResp.h.

Referenced by CigiCollDetVolRespV2::CigiCollDetVolRespV2(), CigiCollDetVolRespV3::CigiCollDetVolRespV3(), GetCollType(), CigiCollDetVolRespV3::Pack(), CigiCollDetVolRespV2::Pack(), SetCollType(), CigiCollDetVolRespV3::Unpack(), and CigiCollDetVolRespV2::Unpack().

Cigi_uint8 CigiBaseCollDetVolResp::CollVolID [protected]

CollVolID
Volume ID with which the referance volume collided

Definition at line 251 of file CigiBaseCollDetVolResp.h.

Referenced by CigiCollDetVolRespV2::CigiCollDetVolRespV2(), CigiCollDetVolRespV3::CigiCollDetVolRespV3(), CigiCollDetVolRespV3::Pack(), and CigiCollDetVolRespV3::Unpack().

Cigi_uint16 CigiBaseCollDetVolResp::EntityID [protected]

EntityID
Entity ID

Definition at line 224 of file CigiBaseCollDetVolResp.h.

Referenced by CigiCollDetVolRespV2::CigiCollDetVolRespV2(), CigiCollDetVolRespV3::CigiCollDetVolRespV3(), GetEntityID(), CigiCollDetVolRespV3::Pack(), CigiCollDetVolRespV2::Pack(), SetEntityID(), CigiCollDetVolRespV3::Unpack(), and CigiCollDetVolRespV2::Unpack().

Cigi_uint8 CigiBaseCollDetVolResp::VolID [protected]

VolID
Volume ID

Definition at line 230 of file CigiBaseCollDetVolResp.h.

Referenced by CigiCollDetVolRespV2::CigiCollDetVolRespV2(), CigiCollDetVolRespV3::CigiCollDetVolRespV3(), CigiCollDetVolRespV3::Pack(), CigiCollDetVolRespV2::Pack(), CigiCollDetVolRespV2::SetVolID(), CigiCollDetVolRespV3::Unpack(), and CigiCollDetVolRespV2::Unpack().

The documentation for this class was generated from the following files:
Generated on Wed Apr 29 09:00:04 2009 for CCL by  doxygen 1.4.7