CigiBaseMotionTrackCtrl Class Reference

#include <CigiBaseMotionTrackCtrl.h>

Inheritance diagram for CigiBaseMotionTrackCtrl:


Public Types
	View = 0
	ViewGrp = 1
enum	ScopeGrp { View = 0, ViewGrp = 1 }
Public Member Functions
	CigiBaseMotionTrackCtrl ()
virtual	~CigiBaseMotionTrackCtrl ()
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	SetViewID (const Cigi_uint16 ViewIDIn, bool bndchk=true)
Cigi_uint16	GetViewID (void) const
int	SetTrackerID (const Cigi_uint8 TrackerIDIn, bool bndchk=true)
Cigi_uint8	GetTrackerID (void) const
int	SetTrackerEn (const bool TrackerEnIn, bool bndchk=true)
bool	GetTrackerEn (void) const
int	SetBoresightEn (const bool BoresightEnIn, bool bndchk=true)
bool	GetBoresightEn (void) const
int	SetXEn (const bool XEnIn, bool bndchk=true)
bool	GetXEn (void) const
int	SetYEn (const bool YEnIn, bool bndchk=true)
bool	GetYEn (void) const
int	SetZEn (const bool ZEnIn, bool bndchk=true)
bool	GetZEn (void) const
int	SetRollEn (const bool RollEnIn, bool bndchk=true)
bool	GetRollEn (void) const
int	SetPitchEn (const bool PitchEnIn, bool bndchk=true)
bool	GetPitchEn (void) const
int	SetYawEn (const bool YawEnIn, bool bndchk=true)
bool	GetYawEn (void) const
int	SetScope (const ScopeGrp ScopeIn, bool bndchk=true)
ScopeGrp	GetScope (void) const
Protected Attributes
Cigi_uint16	ViewID
Cigi_uint8	TrackerID
bool	TrackerEn
bool	BoresightEn
bool	XEn
bool	YEn
bool	ZEn
bool	RollEn
bool	PitchEn
bool	YawEn
ScopeGrp	Scope
Friends
class	CigiMotionTrackCtrlV1
class	CigiMotionTrackCtrlV2
class	CigiMotionTrackCtrlV3

Detailed Description

Definition at line 73 of file CigiBaseMotionTrackCtrl.h.

Member Enumeration Documentation

enum CigiBaseMotionTrackCtrl::ScopeGrp

The enumeration for the CigiBaseMotionTrackCtrl Group

Enumerator:

View
ViewGrp

Definition at line 85 of file CigiBaseMotionTrackCtrl.h.

00086    {
00087       View=0,
00088       ViewGrp=1
00089    };

Constructor & Destructor Documentation

CigiBaseMotionTrackCtrl::CigiBaseMotionTrackCtrl ( )

General Constructor

Definition at line 60 of file CigiBaseMotionTrackCtrl.cpp.

00061 {
00062 
00063 }

CigiBaseMotionTrackCtrl::~CigiBaseMotionTrackCtrl ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseMotionTrackCtrl.cpp.

00071 {
00072 
00073 }

Member Function Documentation

bool CigiBaseMotionTrackCtrl::GetBoresightEn ( void ) const [inline]

Gets the BoresightEn value.

Returns:: the current BoresightEn.

Definition at line 234 of file CigiBaseMotionTrackCtrl.h.

References BoresightEn.

00234 { return(BoresightEn); }

int CigiBaseMotionTrackCtrl::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 CigiBaseMotionTrackCtrl.cpp.

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

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

bool CigiBaseMotionTrackCtrl::GetPitchEn ( void ) const [inline]

Gets the PitchEn value.

Returns:: the current PitchEn.

Definition at line 339 of file CigiBaseMotionTrackCtrl.h.

References PitchEn.

00339 { return(PitchEn); }

bool CigiBaseMotionTrackCtrl::GetRollEn ( void ) const [inline]

Gets the RollEn value.

Returns:: the current RollEn.

Definition at line 318 of file CigiBaseMotionTrackCtrl.h.

References RollEn.

00318 { return(RollEn); }

ScopeGrp CigiBaseMotionTrackCtrl::GetScope ( void ) const [inline]

Gets the Scope value.

Returns:: the current Scope.

Definition at line 379 of file CigiBaseMotionTrackCtrl.h.

References Scope.

00379 { return(Scope); }

bool CigiBaseMotionTrackCtrl::GetTrackerEn ( void ) const [inline]

Gets the TrackEn value.

Returns:: the current TrackEn.

Definition at line 213 of file CigiBaseMotionTrackCtrl.h.

References TrackerEn.

00213 { return(TrackerEn); }

Cigi_uint8 CigiBaseMotionTrackCtrl::GetTrackerID ( void ) const [inline]

Gets the TrackerID value.

Returns:: the current TrackerID.

Definition at line 192 of file CigiBaseMotionTrackCtrl.h.

References TrackerID.

00192 { return(TrackerID); }

Cigi_uint16 CigiBaseMotionTrackCtrl::GetViewID ( void ) const [inline]

Gets the ViewID value.

Returns:: the current ViewID.

Definition at line 171 of file CigiBaseMotionTrackCtrl.h.

References ViewID.

00171 { return(ViewID); }

bool CigiBaseMotionTrackCtrl::GetXEn ( void ) const [inline]

Gets the XEn value.

Returns:: the current XEn.

Definition at line 255 of file CigiBaseMotionTrackCtrl.h.

References XEn.

00255 { return(XEn); }

bool CigiBaseMotionTrackCtrl::GetYawEn ( void ) const [inline]

Gets the YawEn value.

Returns:: the current YawEn.

Definition at line 360 of file CigiBaseMotionTrackCtrl.h.

References YawEn.

00360 { return(YawEn); }

bool CigiBaseMotionTrackCtrl::GetYEn ( void ) const [inline]

Gets the YEn value.

Returns:: the current YEn.

Definition at line 276 of file CigiBaseMotionTrackCtrl.h.

References YEn.

00276 { return(YEn); }

bool CigiBaseMotionTrackCtrl::GetZEn ( void ) const [inline]

Gets the ZEn value.

Returns:: the current ZEn.

Definition at line 297 of file CigiBaseMotionTrackCtrl.h.

References ZEn.

00297 { return(ZEn); }

virtual int CigiBaseMotionTrackCtrl::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 CigiMotionTrackCtrlV3.

int CigiBaseMotionTrackCtrl::SetBoresightEn	(	const bool	BoresightEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the BoresightEn with bound checking control

Parameters:

	BoresightEnIn	- Boresight 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 225 of file CigiBaseMotionTrackCtrl.h.

References BoresightEn, and CIGI_SUCCESS.

00226    {
00227       BoresightEn = BoresightEnIn;
00228       return(CIGI_SUCCESS);
00229    }

int CigiBaseMotionTrackCtrl::SetPitchEn	(	const bool	PitchEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the PitchEn with bound checking control

Parameters:

	PitchEnIn	- Pitch measurement 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 330 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and PitchEn.

00331    {
00332       PitchEn = PitchEnIn;
00333       return(CIGI_SUCCESS);
00334    }

int CigiBaseMotionTrackCtrl::SetRollEn	(	const bool	RollEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the RollEn with bound checking control

Parameters:

	RollEnIn	- Roll measurement 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 309 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and RollEn.

00310    {
00311       RollEn = RollEnIn;
00312       return(CIGI_SUCCESS);
00313    }

int CigiBaseMotionTrackCtrl::SetScope	(	const ScopeGrp	ScopeIn,
		bool	bndchk = `true`
	)

Sets the Scope with bound checking control

Parameters:

	ScopeIn	- Scope of effect View=0 ViewGrp=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 109 of file CigiBaseMotionTrackCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Scope.

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

int CigiBaseMotionTrackCtrl::SetTrackerEn	(	const bool	TrackerEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the TrackEn with bound checking control

Parameters:

	TrackerEnIn	- Tracker 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 204 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and TrackerEn.

00205    {
00206       TrackerEn = TrackerEnIn;
00207       return(CIGI_SUCCESS);
00208    }

int CigiBaseMotionTrackCtrl::SetTrackerID	(	const Cigi_uint8	TrackerIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the TrackerID with bound checking control

Parameters:

	TrackerIDIn	- Tracker 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 183 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and TrackerID.

00184    {
00185       TrackerID = TrackerIDIn;
00186       return(CIGI_SUCCESS);
00187    }

int CigiBaseMotionTrackCtrl::SetViewID	(	const Cigi_uint16	ViewIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ViewID with bound checking control

Parameters:

	ViewIDIn	- View or View Group 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 162 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and ViewID.

00163    {
00164       ViewID = ViewIDIn;
00165       return(CIGI_SUCCESS);
00166    }

int CigiBaseMotionTrackCtrl::SetXEn	(	const bool	XEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the XEn with bound checking control

Parameters:

	XEnIn	- X axis measurement 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 246 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and XEn.

00247    {
00248       XEn = XEnIn;
00249       return(CIGI_SUCCESS);
00250    }

int CigiBaseMotionTrackCtrl::SetYawEn	(	const bool	YawEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the YawEn with bound checking control

Parameters:

	YawEnIn	- Yaw measurement 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 351 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and YawEn.

00352    {
00353       YawEn = YawEnIn;
00354       return(CIGI_SUCCESS);
00355    }

int CigiBaseMotionTrackCtrl::SetYEn	(	const bool	YEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the YEn with bound checking control

Parameters:

	YEnIn	- Y axis measurement 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 267 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and YEn.

00268    {
00269       YEn = YEnIn;
00270       return(CIGI_SUCCESS);
00271    }

int CigiBaseMotionTrackCtrl::SetZEn	(	const bool	ZEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ZEn with bound checking control

Parameters:

	ZEnIn	- Z axis measurement 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 288 of file CigiBaseMotionTrackCtrl.h.

References CIGI_SUCCESS, and ZEn.

00289    {
00290       ZEn = ZEnIn;
00291       return(CIGI_SUCCESS);
00292    }

virtual int CigiBaseMotionTrackCtrl::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 CigiMotionTrackCtrlV3.

Friends And Related Function Documentation

friend class CigiMotionTrackCtrlV1 [friend]

Definition at line 76 of file CigiBaseMotionTrackCtrl.h.

friend class CigiMotionTrackCtrlV2 [friend]

Definition at line 77 of file CigiBaseMotionTrackCtrl.h.

friend class CigiMotionTrackCtrlV3 [friend]

Definition at line 78 of file CigiBaseMotionTrackCtrl.h.

Member Data Documentation

bool CigiBaseMotionTrackCtrl::BoresightEn [protected]

BoresightEn
Boresight enable

Definition at line 409 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetBoresightEn(), CigiMotionTrackCtrlV3::Pack(), SetBoresightEn(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::PitchEn [protected]

PitchEn
Pitch measurement enable

Definition at line 439 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetPitchEn(), CigiMotionTrackCtrlV3::Pack(), SetPitchEn(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::RollEn [protected]

RollEn
Roll measurement enable

Definition at line 433 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetRollEn(), CigiMotionTrackCtrlV3::Pack(), SetRollEn(), and CigiMotionTrackCtrlV3::Unpack().

ScopeGrp CigiBaseMotionTrackCtrl::Scope [protected]

Scope
Scope of effect
0-View
1-ViewGrp

Definition at line 454 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetScope(), CigiMotionTrackCtrlV3::Pack(), SetScope(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::TrackerEn [protected]

TrackerEn
Tracker enable

Definition at line 403 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetTrackerEn(), CigiMotionTrackCtrlV3::Pack(), SetTrackerEn(), and CigiMotionTrackCtrlV3::Unpack().

Cigi_uint8 CigiBaseMotionTrackCtrl::TrackerID [protected]

TrackerID
Tracker ID

Definition at line 397 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetTrackerID(), CigiMotionTrackCtrlV3::Pack(), SetTrackerID(), and CigiMotionTrackCtrlV3::Unpack().

Cigi_uint16 CigiBaseMotionTrackCtrl::ViewID [protected]

ViewID
View or View Group ID

Definition at line 391 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetViewID(), CigiMotionTrackCtrlV3::Pack(), SetViewID(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::XEn [protected]

XEn
X axis measurement enable

Definition at line 415 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetXEn(), CigiMotionTrackCtrlV3::Pack(), SetXEn(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::YawEn [protected]

YawEn
Yaw measurement enable

Definition at line 445 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetYawEn(), CigiMotionTrackCtrlV3::Pack(), SetYawEn(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::YEn [protected]

YEn
Y axis measurement enable

Definition at line 421 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetYEn(), CigiMotionTrackCtrlV3::Pack(), SetYEn(), and CigiMotionTrackCtrlV3::Unpack().

bool CigiBaseMotionTrackCtrl::ZEn [protected]

ZEn
Z axis measurement enable

Definition at line 427 of file CigiBaseMotionTrackCtrl.h.

Referenced by CigiMotionTrackCtrlV3::CigiMotionTrackCtrlV3(), GetZEn(), CigiMotionTrackCtrlV3::Pack(), SetZEn(), and CigiMotionTrackCtrlV3::Unpack().

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

ccl/include/CigiBaseMotionTrackCtrl.h
ccl/source/CigiBaseMotionTrackCtrl.cpp

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

1.4.7

CigiBaseMotionTrackCtrl 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