CigiBasePositionReq Class Reference

#include <CigiBasePositionReq.h>

Inheritance diagram for CigiBasePositionReq:


Public Types
	OneShot = 0
	Continuous = 1
	Entity = 0
	ArtPart = 1
	View = 2
	ViewGrp = 3
	MotionTracker = 4
	Geodetic = 0
	ParentEntity = 1
	Submodel = 2
enum	UpdateModeGrp { OneShot = 0, Continuous = 1 }
enum	ObjectClassGrp { Entity = 0, ArtPart = 1, View = 2, ViewGrp = 3, MotionTracker = 4 }
enum	CoordSysGrp { Geodetic = 0, ParentEntity = 1, Submodel = 2 }
Public Member Functions
	CigiBasePositionReq ()
virtual	~CigiBasePositionReq ()
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	SetObjectID (const Cigi_uint16 ObjectIDIn, bool bndchk=true)
Cigi_uint16	GetObjectID (void) const
int	SetArtPartID (const Cigi_uint8 ArtPartIDIn, bool bndchk=true)
Cigi_uint8	GetArtPartID (void) const
int	SetUpdateMode (const UpdateModeGrp UpdateModeIn, bool bndchk=true)
UpdateModeGrp	GetUpdateMode (void) const
int	SetObjectClass (const ObjectClassGrp ObjectClassIn, bool bndchk=true)
ObjectClassGrp	GetObjectClass (void) const
int	SetCoordSys (const CoordSysGrp CoordSysIn, bool bndchk=true)
CoordSysGrp	GetCoordSys (void) const
Protected Attributes
Cigi_uint16	ObjectID
Cigi_uint8	ArtPartID
UpdateModeGrp	UpdateMode
ObjectClassGrp	ObjectClass
CoordSysGrp	CoordSys
Friends
class	CigiPositionReqV1
class	CigiPositionReqV2
class	CigiPositionReqV3

Detailed Description

Definition at line 73 of file CigiBasePositionReq.h.

Member Enumeration Documentation

enum CigiBasePositionReq::CoordSysGrp

The enumeration for the CigiBasePositionReq Group

Enumerator:

Geodetic
ParentEntity
Submodel

Definition at line 106 of file CigiBasePositionReq.h.

00107    {
00108       Geodetic=0,
00109       ParentEntity=1,
00110       Submodel=2
00111    };

enum CigiBasePositionReq::ObjectClassGrp

The enumeration for the CigiBasePositionReq Group

Enumerator:

Entity
ArtPart
View
ViewGrp
MotionTracker

Definition at line 94 of file CigiBasePositionReq.h.

00095    {
00096       Entity=0,
00097       ArtPart=1,
00098       View=2,
00099       ViewGrp=3,
00100       MotionTracker=4
00101    };

enum CigiBasePositionReq::UpdateModeGrp

The enumeration for the CigiBasePositionReq Group

Enumerator:

OneShot
Continuous

Definition at line 85 of file CigiBasePositionReq.h.

00086    {
00087       OneShot=0,
00088       Continuous=1
00089    };

Constructor & Destructor Documentation

CigiBasePositionReq::CigiBasePositionReq ( )

General Constructor

Definition at line 61 of file CigiBasePositionReq.cpp.

00062 {
00063 
00064 }

CigiBasePositionReq::~CigiBasePositionReq ( ) [virtual]

General Destructor

Definition at line 71 of file CigiBasePositionReq.cpp.

00072 {
00073 
00074 }

Member Function Documentation

Cigi_uint8 CigiBasePositionReq::GetArtPartID ( void ) const [inline]

Gets the ArtPartID value.

Returns:: the current ArtPartID.

Definition at line 214 of file CigiBasePositionReq.h.

References ArtPartID.

00214 { return(ArtPartID); }

int CigiBasePositionReq::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 85 of file CigiBasePositionReq.cpp.

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

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

CoordSysGrp CigiBasePositionReq::GetCoordSys ( void ) const [inline]

Gets the CoordSys value.

Returns:: the current CoordSys.

Definition at line 275 of file CigiBasePositionReq.h.

References CoordSys.

00275 { return(CoordSys); }

ObjectClassGrp CigiBasePositionReq::GetObjectClass ( void ) const [inline]

Gets the ObjectClass value.

Returns:: the current ObjectClass.

Definition at line 255 of file CigiBasePositionReq.h.

References ObjectClass.

00255 { return(ObjectClass); }

Cigi_uint16 CigiBasePositionReq::GetObjectID ( void ) const [inline]

Gets the ObjectID value.

Returns:: the current ObjectID.

Definition at line 193 of file CigiBasePositionReq.h.

References ObjectID.

00193 { return(ObjectID); }

UpdateModeGrp CigiBasePositionReq::GetUpdateMode ( void ) const [inline]

Gets the UpdateMode value.

Returns:: the current UpdateMode.

Definition at line 233 of file CigiBasePositionReq.h.

References UpdateMode.

00233 { return(UpdateMode); }

virtual int CigiBasePositionReq::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 CigiPositionReqV3.

int CigiBasePositionReq::SetArtPartID	(	const Cigi_uint8	ArtPartIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ArtPartID with bound checking control

Parameters:

	ArtPartIDIn	- Articulated Part 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 205 of file CigiBasePositionReq.h.

References ArtPartID, and CIGI_SUCCESS.

00206    {
00207       ArtPartID = ArtPartIDIn;
00208       return(CIGI_SUCCESS);
00209    }

int CigiBasePositionReq::SetCoordSys	(	const CoordSysGrp	CoordSysIn,
		bool	bndchk = `true`
	)

Sets the CoordSys with bound checking control

Parameters:

	CoordSysIn	- Coordinate system used Geodetic=0 ParentEntity=1 Submodel=2
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 155 of file CigiBasePositionReq.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and CoordSys.

00156 {
00157 
00158 #ifndef CIGI_NO_BND_CHK
00159    if(bndchk && ((CoordSysIn < 0)||(CoordSysIn > 2)))
00160    {
00161 #ifndef CIGI_NO_EXCEPT
00162       throw CigiValueOutOfRangeException("CoordSys",(CoordSysGrp)CoordSysIn,0,2);
00163 #endif
00164       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00165    }
00166 #endif
00167 
00168    CoordSys = CoordSysIn;
00169    return(CIGI_SUCCESS);
00170 
00171 }

int CigiBasePositionReq::SetObjectClass	(	const ObjectClassGrp	ObjectClassIn,
		bool	bndchk = `true`
	)

Sets the ObjectClass with bound checking control

Parameters:

	ObjectClassIn	- Type of Object Entity=0 ArtPart=1 View=3 ViewGrp=4 MotionTracker=5
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 133 of file CigiBasePositionReq.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and ObjectClass.

00134 {
00135 
00136 #ifndef CIGI_NO_BND_CHK
00137    if(bndchk && ((ObjectClassIn < 0)||(ObjectClassIn > 5)))
00138    {
00139 #ifndef CIGI_NO_EXCEPT
00140       throw CigiValueOutOfRangeException("ObjectClass",(ObjectClassGrp)ObjectClassIn,0,5);
00141 #endif
00142       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00143    }
00144 #endif
00145 
00146    ObjectClass = ObjectClassIn;
00147    return(CIGI_SUCCESS);
00148 
00149 }

int CigiBasePositionReq::SetObjectID	(	const Cigi_uint16	ObjectIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ObjectID with bound checking control

Parameters:

	ObjectIDIn	- Object 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 CigiBasePositionReq.h.

References CIGI_SUCCESS, and ObjectID.

00185    {
00186       ObjectID = ObjectIDIn;
00187       return(CIGI_SUCCESS);
00188    }

int CigiBasePositionReq::SetUpdateMode	(	const UpdateModeGrp	UpdateModeIn,
		bool	bndchk = `true`
	)

Sets the UpdateMode with bound checking control

Parameters:

	UpdateModeIn	- Update mode OneShot=0 Continuous=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 111 of file CigiBasePositionReq.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and UpdateMode.

00112 {
00113 
00114 #ifndef CIGI_NO_BND_CHK
00115    if(bndchk && ((UpdateModeIn < 0)||(UpdateModeIn > 1)))
00116    {
00117 #ifndef CIGI_NO_EXCEPT
00118       throw CigiValueOutOfRangeException("UpdateMode",(UpdateModeGrp)UpdateModeIn,0,1);
00119 #endif
00120       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00121    }
00122 #endif
00123 
00124    UpdateMode = UpdateModeIn;
00125    return(CIGI_SUCCESS);
00126 
00127 }