CigiBaseConfClampEntityCtrl Class Reference

#include <CigiBaseConfClampEntityCtrl.h>

Inheritance diagram for CigiBaseConfClampEntityCtrl:


Public Member Functions
	CigiBaseConfClampEntityCtrl ()
virtual	~CigiBaseConfClampEntityCtrl ()
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	SetYaw (const float YawIn, bool bndchk=true)
float	GetYaw (void) const
int	SetLat (const double LatIn, bool bndchk=true)
double	GetLat (void) const
int	SetLon (const double LonIn, bool bndchk=true)
double	GetLon (void) const
Protected Attributes
Cigi_uint16	EntityID
float	Yaw
double	Lat
double	Lon
Friends
class	CigiConfClampEntityCtrlV3

Detailed Description

Definition at line 71 of file CigiBaseConfClampEntityCtrl.h.

Constructor & Destructor Documentation

CigiBaseConfClampEntityCtrl::CigiBaseConfClampEntityCtrl ( )

General Constructor

Definition at line 61 of file CigiBaseConfClampEntityCtrl.cpp.

00062 {
00063 
00064 }

CigiBaseConfClampEntityCtrl::~CigiBaseConfClampEntityCtrl ( ) [virtual]

General Destructor

Definition at line 71 of file CigiBaseConfClampEntityCtrl.cpp.

00072 {
00073 
00074 }

Member Function Documentation

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

References CIGI_CONF_CLAMP_ENTITY_CTRL_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_CONF_CLAMP_ENTITY_CTRL_PACKET_ID_V3;
00097    }
00098 
00099    return(CIGI_SUCCESS);
00100 }

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

Gets the EntityID value.

Returns:: the current EntityID.

Definition at line 155 of file CigiBaseConfClampEntityCtrl.h.

References EntityID.

00155 { return(EntityID); }

double CigiBaseConfClampEntityCtrl::GetLat ( void ) const [inline]

Gets the Lat value.

Returns:: the current Lat.

Definition at line 189 of file CigiBaseConfClampEntityCtrl.h.

References Lat.

00189 { return(Lat); }

double CigiBaseConfClampEntityCtrl::GetLon ( void ) const [inline]

Gets the Lon value.

Returns:: the current Lon.

Definition at line 206 of file CigiBaseConfClampEntityCtrl.h.

References Lon.

00206 { return(Lon); }

float CigiBaseConfClampEntityCtrl::GetYaw ( void ) const [inline]

Gets the Yaw value.

Returns:: the current Yaw.

Definition at line 172 of file CigiBaseConfClampEntityCtrl.h.

References Yaw.

00172 { return(Yaw); }

virtual int CigiBaseConfClampEntityCtrl::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 CigiConfClampEntityCtrlV3.

int CigiBaseConfClampEntityCtrl::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 146 of file CigiBaseConfClampEntityCtrl.h.

References CIGI_SUCCESS, and EntityID.

00147    {
00148       EntityID = EntityIDIn;
00149       return(CIGI_SUCCESS);
00150    }

int CigiBaseConfClampEntityCtrl::SetLat	(	const double	LatIn,
		bool	bndchk = `true`
	)

Sets the Lat with bound checking control

Parameters:

	LatIn	- Latitude
	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 CigiBaseConfClampEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Lat.

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

int CigiBaseConfClampEntityCtrl::SetLon	(	const double	LonIn,
		bool	bndchk = `true`
	)

Sets the Lon with bound checking control

Parameters:

	LonIn	- Longitude
	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 CigiBaseConfClampEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Lon.

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

int CigiBaseConfClampEntityCtrl::SetYaw	(	const float	YawIn,
		bool	bndchk = `true`
	)

Sets the Yaw with bound checking control

Parameters:

	YawIn	- Entity yaw
	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 CigiBaseConfClampEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Yaw.

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