CigiBaseSensorCtrl Class Reference

#include <CigiBaseSensorCtrl.h>

Inheritance diagram for CigiBaseSensorCtrl:


Public Types
	WhiteHot = 0
	BlackHot = 1
	TrackOff = 0
	ForceCorrelate = 1
	Scene = 2
	Target = 3
	Ship = 4
	TMDefA = 5
	TMDefB = 6
	TMDefC = 7
	TrackWhite = 0
	TrackBlack = 1
	GatePos = 0
	GateAndTargetPos = 1
enum	PolarityGrp { WhiteHot = 0, BlackHot = 1 }
enum	TrackModeGrp { TrackOff = 0, ForceCorrelate = 1, Scene = 2, Target = 3, Ship = 4, TMDefA = 5, TMDefB = 6, TMDefC = 7 }
enum	TrackPolarityGrp { TrackWhite = 0, TrackBlack = 1 }
enum	ResponseTypeGrp { GatePos = 0, GateAndTargetPos = 1 }
Public Member Functions
	CigiBaseSensorCtrl ()
virtual	~CigiBaseSensorCtrl ()
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	SetSensorID (const Cigi_uint8 SensorIDIn, bool bndchk=true)
Cigi_uint8	GetSensorID (void) const
int	SetSensorOn (const bool SensorOnIn, bool bndchk=true)
bool	GetSensorOn (void) const
int	SetPolarity (const PolarityGrp PolarityIn, bool bndchk=true)
PolarityGrp	GetPolarity (void) const
int	SetLineDropEn (const bool LineDropEnIn, bool bndchk=true)
bool	GetLineDropEn (void) const
int	SetTrackMode (const TrackModeGrp TrackModeIn, bool bndchk=true)
TrackModeGrp	GetTrackMode (void) const
int	SetAutoGainEn (const bool AutoGainEnIn, bool bndchk=true)
bool	GetAutoGainEn (void) const
int	SetTrackPolarity (const TrackPolarityGrp TrackPolarityIn, bool bndchk=true)
TrackPolarityGrp	GetTrackPolarity (void) const
int	SetLevel (const float LevelIn, bool bndchk=true)
float	GetLevel (void) const
int	SetACCoupling (const float ACCouplingIn, bool bndchk=true)
float	GetACCoupling (void) const
int	SetNoise (const float NoiseIn, bool bndchk=true)
float	GetNoise (void) const
Protected Attributes
Cigi_uint16	ViewID
Cigi_uint8	SensorID
bool	SensorOn
PolarityGrp	Polarity
bool	LineDropEn
TrackModeGrp	TrackMode
bool	AutoGainEn
TrackPolarityGrp	TrackPolarity
ResponseTypeGrp	ResponseType
float	Gain
float	Level
float	ACCoupling
float	Noise
Friends
class	CigiSensorCtrlV1
class	CigiSensorCtrlV2
class	CigiSensorCtrlV3

Detailed Description

Definition at line 80 of file CigiBaseSensorCtrl.h.

Member Enumeration Documentation

enum CigiBaseSensorCtrl::PolarityGrp

The enumeration for the CigiBaseSensorCtrl Group

Enumerator:

WhiteHot
BlackHot

Definition at line 92 of file CigiBaseSensorCtrl.h.

00093    {
00094       WhiteHot=0,
00095       BlackHot=1
00096    };

enum CigiBaseSensorCtrl::ResponseTypeGrp

The enumeration for the CigiBaseSensorCtrl Group

Enumerator:

GatePos
GateAndTargetPos

Definition at line 125 of file CigiBaseSensorCtrl.h.

00126    {
00127       GatePos=0,
00128       GateAndTargetPos=1
00129    };

enum CigiBaseSensorCtrl::TrackModeGrp

The enumeration for the CigiBaseSensorCtrl Group

Enumerator:

TrackOff
ForceCorrelate
Scene
Target
Ship
TMDefA
TMDefB
TMDefC

Definition at line 101 of file CigiBaseSensorCtrl.h.

00102    {
00103       TrackOff=0,
00104       ForceCorrelate=1,
00105       Scene=2,
00106       Target=3,
00107       Ship=4,
00108       TMDefA=5,
00109       TMDefB=6,
00110       TMDefC=7
00111    };

enum CigiBaseSensorCtrl::TrackPolarityGrp

The enumeration for the CigiBaseSensorCtrl Group

Enumerator:

TrackWhite
TrackBlack

Definition at line 116 of file CigiBaseSensorCtrl.h.

00117    {
00118       TrackWhite=0,
00119       TrackBlack=1
00120    };

Constructor & Destructor Documentation

CigiBaseSensorCtrl::CigiBaseSensorCtrl ( )

General Constructor

Definition at line 60 of file CigiBaseSensorCtrl.cpp.

00061 {
00062 
00063 }

CigiBaseSensorCtrl::~CigiBaseSensorCtrl ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseSensorCtrl.cpp.

00071 {
00072 
00073 }

Member Function Documentation

float CigiBaseSensorCtrl::GetACCoupling ( void ) const [inline]

Gets the ACCoupling value.

Returns:: the current ACCoupling.

Definition at line 375 of file CigiBaseSensorCtrl.h.

References ACCoupling.

00375 { return(ACCoupling); }

bool CigiBaseSensorCtrl::GetAutoGainEn ( void ) const [inline]

Gets the AutoGainEn value.

Returns:: the current AutoGainEn.

Definition at line 320 of file CigiBaseSensorCtrl.h.

References AutoGainEn.

00320 { return(AutoGainEn); }

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

References CIGI_SENSOR_CTRL_PACKET_ID_V2, CIGI_SENSOR_CTRL_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00086 {
00087    CnvtInfo.ProcID = CigiProcessType::ProcStd;
00088 
00089    if(CnvtVersion.CigiMajorVersion < 3)
00090       CnvtInfo.CnvtPacketID = CIGI_SENSOR_CTRL_PACKET_ID_V2;
00091    else
00092       CnvtInfo.CnvtPacketID = CIGI_SENSOR_CTRL_PACKET_ID_V3;
00093 
00094    return(CIGI_SUCCESS);
00095 }

float CigiBaseSensorCtrl::GetLevel ( void ) const [inline]

Gets the Level value.

Returns:: the current Level.

Definition at line 357 of file CigiBaseSensorCtrl.h.

References Level.

00357 { return(Level); }

bool CigiBaseSensorCtrl::GetLineDropEn ( void ) const [inline]

Gets the LineDropEn value.

Returns:: the current LineDropEn.

Definition at line 275 of file CigiBaseSensorCtrl.h.

References LineDropEn.

00275 { return(LineDropEn); }

float CigiBaseSensorCtrl::GetNoise ( void ) const [inline]

Gets the Noise value.

Returns:: the current Noise.

Definition at line 393 of file CigiBaseSensorCtrl.h.

References Noise.

00393 { return(Noise); }

PolarityGrp CigiBaseSensorCtrl::GetPolarity ( void ) const [inline]

Gets the Polarity value.

Returns:: the current Polarity.

Definition at line 253 of file CigiBaseSensorCtrl.h.

References Polarity.

00253 { return(Polarity); }

Cigi_uint8 CigiBaseSensorCtrl::GetSensorID ( void ) const [inline]

Gets the SensorID value.

Returns:: the current SensorID.

Definition at line 212 of file CigiBaseSensorCtrl.h.

References SensorID.

00212 { return(SensorID); }

bool CigiBaseSensorCtrl::GetSensorOn ( void ) const [inline]

Gets the SensorOn value.

Returns:: the current SensorOn.

Definition at line 233 of file CigiBaseSensorCtrl.h.

References SensorOn.

00233 { return(SensorOn); }

TrackModeGrp CigiBaseSensorCtrl::GetTrackMode ( void ) const [inline]

Gets the TrackMode value.

Returns:: the current TrackMode.

Definition at line 298 of file CigiBaseSensorCtrl.h.

References TrackMode.

00298 { return(TrackMode); }

TrackPolarityGrp CigiBaseSensorCtrl::GetTrackPolarity ( void ) const [inline]

Gets the TrackPolarity value.

Returns:: the current TrackPolarity.

Definition at line 340 of file CigiBaseSensorCtrl.h.

References TrackPolarity.

00340 { return(TrackPolarity); }

virtual int CigiBaseSensorCtrl::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 CigiSensorCtrlV1, CigiSensorCtrlV2, and CigiSensorCtrlV3.

int CigiBaseSensorCtrl::SetACCoupling	(	const float	ACCouplingIn,
		bool	bndchk = `true`
	)

Sets the ACCoupling with bound checking control

Parameters:

	ACCouplingIn	- This specifies the AC Coupling control of the seeker.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 194 of file CigiBaseSensorCtrl.cpp.

References ACCoupling, CIGI_ERROR_VALUE_OUT_OF_RANGE, and CIGI_SUCCESS.

00195 {
00196 
00197 #ifndef CIGI_NO_BND_CHK
00198    if(bndchk && (ACCouplingIn < 0.0))
00199    {
00200 #ifndef CIGI_NO_EXCEPT
00201       throw CigiValueOutOfRangeException("ACCoupling",(float)ACCouplingIn,">=",0.0);
00202 #endif
00203       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00204    }
00205 #endif
00206 
00207    ACCoupling = ACCouplingIn;
00208    return(CIGI_SUCCESS);
00209 
00210 }

int CigiBaseSensorCtrl::SetAutoGainEn	(	const bool	AutoGainEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the AutoGainEn with bound checking control

Parameters:

	AutoGainEnIn	- Specifies whether the auto gain feature is enabled (true) or disabled (false).
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 311 of file CigiBaseSensorCtrl.h.

References AutoGainEn, and CIGI_SUCCESS.

00312    {
00313       AutoGainEn = AutoGainEnIn;
00314       return(CIGI_SUCCESS);
00315    }

int CigiBaseSensorCtrl::SetLevel	(	const float	LevelIn,
		bool	bndchk = `true`
	)

Sets the Level with bound checking control

Parameters:

	LevelIn	- This specifies the level control of the seeker.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 172 of file CigiBaseSensorCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Level.

00173 {
00174 
00175 #ifndef CIGI_NO_BND_CHK
00176    if(bndchk && ((LevelIn < 0.0)||(LevelIn > 1.0)))
00177    {
00178 #ifndef CIGI_NO_EXCEPT
00179       throw CigiValueOutOfRangeException("Level",(float)LevelIn,0.0,1.0);
00180 #endif
00181       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00182    }
00183 #endif
00184 
00185    Level = LevelIn;
00186    return(CIGI_SUCCESS);
00187 
00188 }

int CigiBaseSensorCtrl::SetLineDropEn	(	const bool	LineDropEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the LineDropEn with bound checking control

Parameters:

	LineDropEnIn	- Specifies whether the line-by-line dropout feature is enabled (true) or disabled (false).
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 266 of file CigiBaseSensorCtrl.h.

References CIGI_SUCCESS, and LineDropEn.

00267    {
00268       LineDropEn = LineDropEnIn;
00269       return(CIGI_SUCCESS);
00270    }

int CigiBaseSensorCtrl::SetNoise	(	const float	NoiseIn,
		bool	bndchk = `true`
	)

Sets the Noise with bound checking control

Parameters:

	NoiseIn	- This specifies the noise to show in the sensor display.
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 216 of file CigiBaseSensorCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Noise.

00217 {
00218 
00219 #ifndef CIGI_NO_BND_CHK
00220    if(bndchk && ((NoiseIn < 0.0)||(NoiseIn > 1.0)))
00221    {
00222 #ifndef CIGI_NO_EXCEPT
00223       throw CigiValueOutOfRangeException("Noise",(float)NoiseIn,0.0,1.0);
00224 #endif
00225       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00226    }
00227 #endif
00228 
00229    Noise = NoiseIn;
00230    return(CIGI_SUCCESS);
00231 
00232 }

int CigiBaseSensorCtrl::SetPolarity	(	const PolarityGrp	PolarityIn,
		bool	bndchk = `true`
	)

Sets the Polarity with bound checking control

Parameters:

	PolarityIn	- Specifies what intesity pole by which hot and cold are represented. WhiteHot=0 BlackHot=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 106 of file CigiBaseSensorCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Polarity.

00107 {
00108 
00109 #ifndef CIGI_NO_BND_CHK
00110    if(bndchk && ((PolarityIn < 0)||(PolarityIn > 1)))
00111    {
00112 #ifndef CIGI_NO_EXCEPT
00113       throw CigiValueOutOfRangeException("Polarity",(PolarityGrp)PolarityIn,0,1);
00114 #endif
00115       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00116    }
00117 #endif
00118 
00119    Polarity = PolarityIn;
00120    return(CIGI_SUCCESS);
00121 
00122 }

int CigiBaseSensorCtrl::SetSensorID	(	const Cigi_uint8	SensorIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SensorID with bound checking control

Parameters:

	SensorIDIn	- The unique id identifying the specific sensor that this packet is being applied.
	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 CigiBaseSensorCtrl.h.

References CIGI_SUCCESS, and SensorID.

00204    {
00205       SensorID = SensorIDIn;
00206       return(CIGI_SUCCESS);
00207    }

int CigiBaseSensorCtrl::SetSensorOn	(	const bool	SensorOnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SensorOn with bound checking control

Parameters:

	SensorOnIn	- Specifies whether the sensor is on(true) or off(false).
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 224 of file CigiBaseSensorCtrl.h.

References CIGI_SUCCESS, and SensorOn.

00225    {
00226       SensorOn = SensorOnIn;
00227       return(CIGI_SUCCESS);
00228    }

int CigiBaseSensorCtrl::SetTrackMode	(	const TrackModeGrp	TrackModeIn,
		bool	bndchk = `true`
	)

Sets the TrackMode with bound checking control

Parameters:

	TrackModeIn	- Specifies in which mode the tracker should be currently operating. TrackOff=0 ForceCorrelate=1 Scene=2 Target=3 Ship=4
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 128 of file CigiBaseSensorCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and TrackMode.

00129 {
00130 
00131 #ifndef CIGI_NO_BND_CHK
00132    if(bndchk && ((TrackModeIn < 0)||(TrackModeIn > 7)))
00133    {
00134 #ifndef CIGI_NO_EXCEPT
00135       throw CigiValueOutOfRangeException("TrackMode",(TrackModeGrp)TrackModeIn,0,7);
00136 #endif
00137       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00138    }
00139 #endif
00140 
00141    TrackMode = TrackModeIn;
00142    return(CIGI_SUCCESS);
00143 
00144 }

int CigiBaseSensorCtrl::SetTrackPolarity	(	const TrackPolarityGrp	TrackPolarityIn,
		bool	bndchk = `true`
	)

Sets the TrackPolarity with bound checking control

Parameters:

	TrackPolarityIn	- Specifies whether the sensor should track a white or black area. TrackWhite=0 TrackBlack=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 150 of file CigiBaseSensorCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and TrackPolarity.

00151 {
00152 
00153 #ifndef CIGI_NO_BND_CHK
00154    if(bndchk && ((TrackPolarityIn < 0)||(TrackPolarityIn > 1)))
00155    {
00156 #ifndef CIGI_NO_EXCEPT
00157       throw CigiValueOutOfRangeException("TrackPolarity",(TrackPolarityGrp)TrackPolarityIn,0,1);
00158 #endif
00159       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00160    }
00161 #endif
00162 
00163    TrackPolarity = TrackPolarityIn;
00164    return(CIGI_SUCCESS);
00165 
00166 }

virtual int CigiBaseSensorCtrl::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 CigiSensorCtrlV1, CigiSensorCtrlV2, and CigiSensorCtrlV3.

Friends And Related Function Documentation

friend class CigiSensorCtrlV1 [friend]

Definition at line 83 of file CigiBaseSensorCtrl.h.

friend class CigiSensorCtrlV2 [friend]

Definition at line 84 of file CigiBaseSensorCtrl.h.

friend class CigiSensorCtrlV3 [friend]

Definition at line 85 of file CigiBaseSensorCtrl.h.

Member Data Documentation

float CigiBaseSensorCtrl::ACCoupling [protected]

ACCoupling
Specifies the AC Coupling control for the sensor. (0.0 - 1.0)

Definition at line 491 of file CigiBaseSensorCtrl.h.

Referenced by CigiSensorCtrlV1::CigiSensorCtrlV1(), CigiSensorCtrlV2::CigiSensorCtrlV2(), CigiSensorCtrlV3::CigiSensorCtrlV3(), GetACCoupling(), CigiSensorCtrlV3::Pack(), CigiSensorCtrlV2::Pack(), CigiSensorCtrlV1::Pack(), SetACCoupling(), CigiSensorCtrlV3::Unpack(), CigiSensorCtrlV2::Unpack(), and CigiSensorCtrlV1::Unpack().

bool CigiBaseSensorCtrl::AutoGainEn [protected]

AutoGainEn
Specifies whether the autogain feature of the sensor is enabled (true) or disabled (false).

Definition at line 451 of file CigiBaseSensorCtrl.h.

Referenced by CigiSensorCtrlV1::CigiSensorCtrlV1(), CigiSensorCtrlV2::CigiSensorCtrlV2(), CigiSensorCtrlV3::CigiSensorCtrlV3(), GetAutoGainEn(), CigiSensorCtrlV3::Pack(), CigiSensorCtrlV2::Pack(), CigiSensorCtrlV1::Pack(), SetAutoGainEn(), CigiSensorCtrlV3::Unpack(), CigiSensorCtrlV2::Unpack(), and CigiSensorCtrlV1::Unpack().

float CigiBaseSensorCtrl::Gain [protected]

Gain
Specifies the gain control for the sensor. (0.0 - 1.0) (Note: CIGI 1 values are 0.0 - 100.0: this is converted to 0.0 - 1.0 before storing in Gain.)

Definition at line 477 of file CigiBaseSensorCtrl.h.

Referenced by CigiSensorCtrlV1::CigiSensorCtrlV1(), CigiSensorCtrlV2::CigiSensorCtrlV2(), CigiSensorCtrlV3::CigiSensorCtrlV3(), CigiSensorCtrlV3::Pack(), CigiSensorCtrlV2::Pack(), CigiSensorCtrlV1::Pack(), CigiSensorCtrlV3::SetGain(), CigiSensorCtrlV2::SetGain(), CigiSensorCtrlV1::SetGain(), CigiSensorCtrlV3::Unpack(), CigiSensorCtrlV2::Unpack(), and CigiSensorCtrlV1::Unpack().