CigiBaseCollDetVolDef Class Reference

#include <CigiBaseCollDetVolDef.h>

Inheritance diagram for CigiBaseCollDetVolDef:


Public Types
	Sphere = 0
	Cuboid = 1
enum	VolTypeGrp { Sphere = 0, Cuboid = 1 }
Public Member Functions
	CigiBaseCollDetVolDef ()
virtual	~CigiBaseCollDetVolDef ()
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	SetVolID (const Cigi_uint8 VolIDIn, bool bndchk=true)
Cigi_uint8	GetVolID (void) const
int	SetVolEn (const bool VolEnIn, bool bndchk=true)
bool	GetVolEn (void) const
int	SetXoff (const float XoffIn, bool bndchk=true)
float	GetXoff (void) const
int	SetYoff (const float YoffIn, bool bndchk=true)
float	GetYoff (void) const
int	SetZoff (const float ZoffIn, bool bndchk=true)
float	GetZoff (void) const
int	SetHeightOrRadius (const float HeightOrRadiusIn, bool bndchk=true)
float	GetHeightOrRadius (void) const
int	SetWidth (const float WidthIn, bool bndchk=true)
float	GetWidth (void) const
int	SetDepth (const float DepthIn, bool bndchk=true)
float	GetDepth (void) const
Protected Attributes
Cigi_uint16	EntityID
Cigi_uint8	VolID
bool	VolEn
VolTypeGrp	VolType
float	Xoff
float	Yoff
float	Zoff
float	HeightOrRadius
float	Width
float	Depth
float	Roll
float	Pitch
float	Yaw
Friends
class	CigiCollDetVolDefV2
class	CigiCollDetVolDefV3

Detailed Description

Definition at line 75 of file CigiBaseCollDetVolDef.h.

Member Enumeration Documentation

enum CigiBaseCollDetVolDef::VolTypeGrp

The enumeration for the CigiBaseCollDetVolDef Group

Enumerator:

Sphere
Cuboid

Definition at line 86 of file CigiBaseCollDetVolDef.h.

00087    {
00088       Sphere=0,
00089       Cuboid=1
00090    };

Constructor & Destructor Documentation

CigiBaseCollDetVolDef::CigiBaseCollDetVolDef ( )

General Constructor

Definition at line 60 of file CigiBaseCollDetVolDef.cpp.

00061 {
00062 
00063 }

CigiBaseCollDetVolDef::~CigiBaseCollDetVolDef ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseCollDetVolDef.cpp.

00071 {
00072 
00073 }

Member Function Documentation

int CigiBaseCollDetVolDef::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 83 of file CigiBaseCollDetVolDef.cpp.

References CIGI_COLL_DET_VOL_DEF_PACKET_ID_V2, CIGI_COLL_DET_VOL_DEF_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

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

float CigiBaseCollDetVolDef::GetDepth ( void ) const [inline]

Gets the Depth value.

Returns:: the current Depth.

Definition at line 343 of file CigiBaseCollDetVolDef.h.

References Depth.

00343 { return(Depth); }

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

Gets the EntityID value.

Returns:: the current EntityID.

Definition at line 172 of file CigiBaseCollDetVolDef.h.

References EntityID.

00172 { return(EntityID); }

float CigiBaseCollDetVolDef::GetHeightOrRadius ( void ) const [inline]

Gets the HeightOrRadius value.

Returns:: the current HeightOrRadius.

Definition at line 301 of file CigiBaseCollDetVolDef.h.

References HeightOrRadius.

00301 { return(HeightOrRadius); }

bool CigiBaseCollDetVolDef::GetVolEn ( void ) const [inline]

Gets the VolEn value.

Returns:: the current VolEn.

Definition at line 214 of file CigiBaseCollDetVolDef.h.

References VolEn.

00214 { return(VolEn); }

Cigi_uint8 CigiBaseCollDetVolDef::GetVolID ( void ) const [inline]

Gets the VolID value.

Returns:: the current VolID.

Definition at line 193 of file CigiBaseCollDetVolDef.h.

References VolID.

00193 { return(VolID); }

float CigiBaseCollDetVolDef::GetWidth ( void ) const [inline]

Gets the Width value.

Returns:: the current Width.

Definition at line 322 of file CigiBaseCollDetVolDef.h.

References Width.

00322 { return(Width); }

float CigiBaseCollDetVolDef::GetXoff ( void ) const [inline]

Gets the Xoff value.

Returns:: the current Xoff.

Definition at line 236 of file CigiBaseCollDetVolDef.h.

References Xoff.

00236 { return(Xoff); }

float CigiBaseCollDetVolDef::GetYoff ( void ) const [inline]

Gets the Yoff value.

Returns:: the current Yoff.

Definition at line 258 of file CigiBaseCollDetVolDef.h.

References Yoff.

00258 { return(Yoff); }

float CigiBaseCollDetVolDef::GetZoff ( void ) const [inline]

Gets the Zoff value.

Returns:: the current Zoff.

Definition at line 280 of file CigiBaseCollDetVolDef.h.

References Zoff.

00280 { return(Zoff); }

virtual int CigiBaseCollDetVolDef::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 CigiCollDetVolDefV2, and CigiCollDetVolDefV3.

int CigiBaseCollDetVolDef::SetDepth	(	const float	DepthIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Depth with bound checking control

Parameters:

	DepthIn	- The depth of the volume.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 334 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and Depth.

00335    {
00336       Depth = DepthIn;
00337       return(CIGI_SUCCESS);
00338    }

int CigiBaseCollDetVolDef::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 CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and EntityID.

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

int CigiBaseCollDetVolDef::SetHeightOrRadius	(	const float	HeightOrRadiusIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the HeightOrRadius with bound checking control

Parameters:

	HeightOrRadiusIn	- The height or radius of the volume.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 292 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and HeightOrRadius.

00293    {
00294       HeightOrRadius = HeightOrRadiusIn;
00295       return(CIGI_SUCCESS);
00296    }

int CigiBaseCollDetVolDef::SetVolEn	(	const bool	VolEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the VolEn with bound checking control

Parameters:

	VolEnIn	- Volume enable
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 205 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and VolEn.

00206    {
00207       VolEn = VolEnIn;
00208       return(CIGI_SUCCESS);
00209    }

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

Sets the VolID with bound checking control

Parameters:

	VolIDIn	- Volume 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 184 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and VolID.

00185    {
00186       VolID = VolIDIn;
00187       return(CIGI_SUCCESS);
00188    }

int CigiBaseCollDetVolDef::SetWidth	(	const float	WidthIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Width with bound checking control

Parameters:

	WidthIn	- The width of the volume.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 313 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and Width.

00314    {
00315       Width = WidthIn;
00316       return(CIGI_SUCCESS);
00317    }

int CigiBaseCollDetVolDef::SetXoff	(	const float	XoffIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Xoff with bound checking control

Parameters:

	XoffIn	- Offset along the X axis of the referance entity from its origin.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 227 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and Xoff.

00228    {
00229       Xoff = XoffIn;
00230       return(CIGI_SUCCESS);
00231    }

int CigiBaseCollDetVolDef::SetYoff	(	const float	YoffIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Yoff with bound checking control

Parameters:

	YoffIn	- Offset along the Y axis of the referance entity from its origin.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 249 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and Yoff.

00250    {
00251       Yoff = YoffIn;
00252       return(CIGI_SUCCESS);
00253    }

int CigiBaseCollDetVolDef::SetZoff	(	const float	ZoffIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Zoff with bound checking control

Parameters:

	ZoffIn	- Offset along the Z axis of the referance entity from its origin.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 271 of file CigiBaseCollDetVolDef.h.

References CIGI_SUCCESS, and Zoff.

00272    {
00273       Zoff = ZoffIn;
00274       return(CIGI_SUCCESS);
00275    }

virtual int CigiBaseCollDetVolDef::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 CigiCollDetVolDefV2, and CigiCollDetVolDefV3.

Friends And Related Function Documentation

friend class CigiCollDetVolDefV2 [friend]

Definition at line 78 of file CigiBaseCollDetVolDef.h.

friend class CigiCollDetVolDefV3 [friend]

Definition at line 79 of file CigiBaseCollDetVolDef.h.

Member Data Documentation

float CigiBaseCollDetVolDef::Depth [protected]

Depth
The volume's depth

Definition at line 411 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetDepth(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetDepth(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

Cigi_uint16 CigiBaseCollDetVolDef::EntityID [protected]

EntityID
Entity ID

Definition at line 355 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetEntityID(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetEntityID(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

float CigiBaseCollDetVolDef::HeightOrRadius [protected]

HeightOrRadius
The volume's height or radius

Definition at line 399 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetHeightOrRadius(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetHeightOrRadius(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

float CigiBaseCollDetVolDef::Pitch [protected]

Pitch
The volume's pitch relative to the referance entity.

Definition at line 423 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV3::SetPitch(), and CigiCollDetVolDefV3::Unpack().

float CigiBaseCollDetVolDef::Roll [protected]

Roll
The volume's roll relative to the referance entity.

Definition at line 417 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV3::SetRoll(), and CigiCollDetVolDefV3::Unpack().

bool CigiBaseCollDetVolDef::VolEn [protected]

VolEn
Volume enable

Definition at line 367 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetVolEn(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetVolEn(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

Cigi_uint8 CigiBaseCollDetVolDef::VolID [protected]

VolID
Volume ID

Definition at line 361 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetVolID(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetVolID(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

VolTypeGrp CigiBaseCollDetVolDef::VolType [protected]

VolType
Volume type.
0-Sphere
1-Cuboid

Definition at line 375 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV3::SetVolType(), and CigiCollDetVolDefV3::Unpack().

float CigiBaseCollDetVolDef::Width [protected]

Width
The volume's width

Definition at line 405 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetWidth(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetWidth(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

float CigiBaseCollDetVolDef::Xoff [protected]

Xoff
Offset along the X axis of the referance entity from its origin.

Definition at line 381 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetXoff(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetXoff(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

float CigiBaseCollDetVolDef::Yaw [protected]

Yaw
The volume's yaw relative to the referance entity.

Definition at line 429 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV3::SetYaw(), and CigiCollDetVolDefV3::Unpack().

float CigiBaseCollDetVolDef::Yoff [protected]

Yoff
Offset along the Y axis of the referance entity from its origin.

Definition at line 387 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetYoff(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetYoff(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

float CigiBaseCollDetVolDef::Zoff [protected]

Zoff
Offset along the Z axis of the referance entity from its origin.

Definition at line 393 of file CigiBaseCollDetVolDef.h.

Referenced by CigiCollDetVolDefV2::CigiCollDetVolDefV2(), CigiCollDetVolDefV3::CigiCollDetVolDefV3(), GetZoff(), CigiCollDetVolDefV3::Pack(), CigiCollDetVolDefV2::Pack(), SetZoff(), CigiCollDetVolDefV3::Unpack(), and CigiCollDetVolDefV2::Unpack().

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

ccl/include/CigiBaseCollDetVolDef.h
ccl/source/CigiBaseCollDetVolDef.cpp

Generated on Wed Apr 29 09:00:04 2009 for CCL by

1.4.7

CigiBaseCollDetVolDef Class Reference

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation