Public Types
enum	enumSensorType { Passive_EO, Passive_MWIR, Passive_LWIR, IR3, IR4, IR5, IR6, IR7, IR8, EOIR, Passive_SIGINT, Passive_COMM, COMM2, COMM3, COMM4, COMM5, COMM6, COMM7, COMM8, COMM9, Active_COMM, Active_RADAR }

Public Member Functions
	ciSigSimSensor ()
	ciSigSimSensor (ciSigSimSensor &obj)
virtual	~ciSigSimSensor ()
ciSigSimSensor	operator= (ciSigSimSensor &obj)
bool	CreateSensor ()
bool	CreateSensor (int nSensors)
bool	CreateDefaultSensor ()
void	DestroySigSimSENSORArrays ()
bool	AddSensor (ciSigSimSensor sensor)
bool	RemoveSensor (int sensorIdx)
bool	InsertSensor (int placeBeforeIdx, ciSigSimSensor sensor)
void	DeleteAllSensors ()
void	SetType (int type)
void	SetType (int sensorIdx, int type)
int	GetType ()
int	GetType (int sensorIdx)
void	setName (char name[SIGSIM_STRING_SIZE])
void	setName (int sensorIdx, char name[SIGSIM_STRING_SIZE])
char *	getName ()
char *	getName (int sensorIdx)
void	SetFOVSamples (int horz, int vert)
void	SetFOVSamples (int sensorIdx, int horz, int vert)
void	GetFOVSamples (int &horz, int &vert)
void	GetFOVSamples (int sensorIdx, int &horz, int &vert)
void	setTemperatureLimits (double tMax, double tMin)
void	setTemperatureLimits (int sensorIdx, double tMax, double tMin)
void	getTemperatureLimits (double &tMax, double &tMin)
void	getTemperatureLimits (int sensorIdx, double &tMax, double &tMin)
void	setMaxLightLevel (double maxLightLevel)
void	setMaxLightLevel (int sensorIdx, double maxLightLevel)
double	getMaxLightLevel ()
double	getMaxLightLevel (int sensorIdx)
void	SetGain (double gain)
void	SetGain (int sensorIdx, double gain)
double	GetGain ()
double	GetGain (int sensorIdx)
void	SetLevel (double level)
void	SetLevel (int sensorIdx, double level)
double	GetLevel ()
double	GetLevel (int sensorIdx)
void	setFOVDegrees (double horz, double vert)
void	setFOVDegrees (int sensorIdx, double horz, double vert)
void	getFOVDegrees (double &horz, double &vert)
void	getFOVDegrees (int sensorIdx, double &horz, double &vert)
void	SetFOV_NEDView (double i, double j, double k)
void	SetFOV_NEDView (int sensorIdx, double i, double j, double k)
void	GetFOV_NEDView (double &i, double &j, double &k)
void	GetFOV_NEDView (int sensorIdx, double &i, double &j, double &k)
void	SetFOVGeodetic (double latitude, double longitude, double altitude)
void	SetFOVGeodetic (int sensorIdx, double latitude, double longitude, double altitude)
void	GetFOVGeodetic (double &latitude, double &longitude, double &altitude)
void	GetFOVGeodetic (int sensorIdx, double &latitude, double &longitude, double &altitude)
void	setBandInfo (double ax, double bx, int nBins)
void	setBandInfo (int sensorIdx, double ax, double bx, int nBins)
void	setBandInfo (double ax, double bx, double dx)
void	setBandInfo (int sensorIdx, double ax, double bx, double dx)
void	getBandInfo (double &ax, double &bx, int &nBins)
void	getBandInfo (int sensorIdx, double &ax, double &bx, int &nBins)
void	getBandInfo (double &ax, double &bx, double &dx)
void	getBandInfo (int sensorIdx, double &ax, double &bx, double &dx)
SENSOR *	GetSigSimSensor ()
int	GetNumberOfSensors ()
bool	archive (char *filepath)
bool	serialize (char *filepath)

Private Attributes
SENSOR *	m_sigSimSensor
int	m_numSensors

Detailed Description

ciSigSimSensor class declaration

Member Enumeration Documentation

enum ciSigSimSensor::enumSensorType

Description: Enumerates the available sensor types.

Enumerator:

Passive_EO	0
Passive_MWIR	1
Passive_LWIR	2
IR3	3
IR4	4
IR5	5
IR6	6
IR7	7
IR8	8
EOIR	9
Passive_SIGINT	10
Passive_COMM	11
COMM2	12
COMM3	13
COMM4	14
COMM5	15
COMM6	16
COMM7	17
COMM8	18
COMM9	19
Active_COMM	20
Active_RADAR	21

Constructor & Destructor Documentation

ciSigSimSensor::ciSigSimSensor ( )

ciSigSimSensor::ciSigSimSensor ( ciSigSimSensor & obj )

virtual ciSigSimSensor::~ciSigSimSensor ( )

virtual

Member Function Documentation

ciSigSimSensor ciSigSimSensor::operator= ( ciSigSimSensor & obj )

Description:: Overloaded assignment operator.

Parameters

obj	- the ciSigSimSensor object to assign

Returns: the assigned ciSigSimSensor object.

Note: Assigns a copy of obj to the current object's this pointer. However, SigSim allocates memory to several arrays within the SENSOR structure, care must be taken to ensure memory is either freed appropriately or otherwise handled prior to assignment.

bool ciSigSimSensor::CreateSensor ( )

Description:: Creates a new, uninitialized sensor object.

Returns: true if successful.

bool ciSigSimSensor::CreateSensor ( int nSensors )

Description:: Creates a new, uninitialized sensor list.

Parameters

nSensors - Sets the number of sensors to be created

Returns: true if successful.

bool ciSigSimSensor::CreateDefaultSensor ( )

Description:: Creates a new sensor object with some standard, default sensor parameters.

Returns: true if successful.

void ciSigSimSensor::DestroySigSimSENSORArrays ( )

Description:: Frees the sensor arrays, if allocated by SigSim.

Returns: void

Note: Must be called explicitly at the end of a SigSim run to free any memory that SigSim may have allocated without the contolling app's knowledge...

See Also: DeleteAllSensors()

bool ciSigSimSensor::AddSensor ( ciSigSimSensor sensor )

Description:: Adds a sensor to the tail of the sensor list.

Parameters

sensor - ciSigSimSensor sensor object to be added

Returns: true if successful.

Note: Ensures the sensor list is a contiguous array.

See Also: InsertSensor()

bool ciSigSimSensor::RemoveSensor ( int sensorIdx )

Description:: Removes a sensor from the sensor list.

Parameters

sensorIdx - index in the sensor list of the sensor to remove

Returns: true if successful.

Note: Ensures the sensor list is a contiguous array.

bool ciSigSimSensor::InsertSensor	(	int	placeBeforeIdx,
		ciSigSimSensor	sensor
	)

Description:: Inserts a sensor to prior to the indicated index.

Parameters

placeBeforeIdx	- the sensor index to insert the new sensor. 0 will place it at the head of the list, -1 will place it at the tail of the list.
sensor	- ciSigSimSensor sensor object to be added

Returns: true if successful.

Note: Ensures the sensor list is a contiguous array.

void ciSigSimSensor::DeleteAllSensors ( )

Description:: Removes all sensor from the list and frees any memory allocated.

Returns: void

void ciSigSimSensor::SetType ( int type )

Description:: Sets the type of the sensor.

Parameters

type	- sets the type of sensor

Returns: void

See Also: ciSigSimSensor::enumSensorType

void ciSigSimSensor::SetType	(	int	sensorIdx,
		int	type
	)

Description:: Sets the type of the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
type	- sets the type of sensor

Returns: void

See Also: ciSigSimSensor::enumSensorType

int ciSigSimSensor::GetType ( )

Description:: Gets the type of the sensor.

Returns: An enumerated integer specifying the sensor type.

See Also: ciSigSimSensor::enumSensorType

int ciSigSimSensor::GetType ( int sensorIdx )

Description:: Gets the type of the sensor.

Parameters

sensorIdx - index in the sensor list of the sensor data

Returns: An enumerated integer specifying the sensor type.

See Also: ciSigSimSensor::enumSensorType

void ciSigSimSensor::setName ( char name[SIGSIM_STRING_SIZE] )

Description:: Sets the name of the sensor.

Parameters

name	- sets the sensor name

Returns: void

Note: SIGSIM_STRING_SIZE is defined as 255.

void ciSigSimSensor::setName	(	int	sensorIdx,
		char	name[SIGSIM_STRING_SIZE]
	)

Description:: Sets the name of the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
name	- sets the sensor name

Returns: void

Note: SIGSIM_STRING_SIZE is defined as 255.

char* ciSigSimSensor::getName ( )

Description:: Gets the name of the sensor.

Returns: A pointer to the sensor's name.

Note: The pointer is temporary, and should not be stored.

char* ciSigSimSensor::getName ( int sensorIdx )

Description:: Gets the name of the sensor.

Parameters

sensorIdx - index in the sensor list of the sensor data

Returns: A pointer to the sensor's name.

Note: The pointer is temporary, and should not be stored.

void ciSigSimSensor::SetFOVSamples	(	int	horz,
		int	vert
	)

Description:: Sets number of pixels in the sensor FOV sample.

Parameters

horz	- sets the horizontal FOV sample (in pixels)
vert	- sets the verticle FOV sample (in pixels)

Returns: void

void ciSigSimSensor::SetFOVSamples	(	int	sensorIdx,
		int	horz,
		int	vert
	)

Description:: Sets number of pixels in the sensor FOV sample.

Parameters

sensorIdx	- index in the sensor list of the sensor data
horz	- sets the horizontal FOV sample (in pixels)
vert	- sets the verticle FOV sample (in pixels)

Returns: void

void ciSigSimSensor::GetFOVSamples	(	int &	horz,
		int &	vert
	)

Description:: Gets number of pixels in the sensor FOV sample.

Parameters

horz	- returns the horizontal FOV sample (in pixels)
vert	- returns the verticle FOV sample (in pixels)

Returns: void

void ciSigSimSensor::GetFOVSamples	(	int	sensorIdx,
		int &	horz,
		int &	vert
	)

Description:: Gets number of pixels in the sensor FOV sample.

Parameters

sensorIdx	- index in the sensor list of the sensor data
horz	- returns the horizontal FOV sample (in pixels)
vert	- returns the verticle FOV sample (in pixels)

Returns: void

void ciSigSimSensor::setTemperatureLimits	(	double	tMax,
		double	tMin
	)

Description:: Sets the sensor temperature limits.

Parameters

tMax	- sets the max thermal sensor dynamic range [deg C]
tMin	- sets the min thermal sensor dynamic range [deg C]

Returns: void

void ciSigSimSensor::setTemperatureLimits	(	int	sensorIdx,
		double	tMax,
		double	tMin
	)

Description:: Sets the sensor temperature limits.

Parameters

sensorIdx	- index in the sensor list of the sensor data
tMax	- sets the max thermal sensor dynamic range [deg C]
tMin	- sets the min thermal sensor dynamic range [deg C]

Returns: void

void ciSigSimSensor::getTemperatureLimits	(	double &	tMax,
		double &	tMin
	)

Description:: Gets the sensor temperature limits.

Parameters

tMax	- returns the max thermal sensor dynamic range [deg C]
tMin	- returns the min thermal sensor dynamic range [deg C]

Returns: void

void ciSigSimSensor::getTemperatureLimits	(	int	sensorIdx,
		double &	tMax,
		double &	tMin
	)

Description:: Gets the sensor temperature limits.

Parameters

sensorIdx	- index in the sensor list of the sensor data
tMax	- returns the max thermal sensor dynamic range [deg C]
tMin	- returns the min thermal sensor dynamic range [deg C]

Returns: void

void ciSigSimSensor::setMaxLightLevel ( double maxLightLevel )

Description:: Sets the NVG sensor maximum light level.

Parameters

maxLightLevel - sets the maximum NVG sensor light level [uW/cm2].

Returns: void

void ciSigSimSensor::setMaxLightLevel	(	int	sensorIdx,
		double	maxLightLevel
	)

Description:: Sets the NVG sensor maximum light level.

Parameters

sensorIdx	- index in the sensor list of the sensor data
maxLightLevel	- sets the maximum NVG sensor light level [uW/cm2].

Returns: void

double ciSigSimSensor::getMaxLightLevel ( )

Description:: Gets the sensor maximum light level.

Returns: The sensor maximum NVG sensor light level [uW/cm2].

double ciSigSimSensor::getMaxLightLevel ( int sensorIdx )

Description:: Gets the sensor maximum light level.

Parameters

sensorIdx - index in the sensor list of the sensor data

Returns: The sensor maximum NVG sensor light level [uW/cm2].

void ciSigSimSensor::SetGain ( double gain )

Description:: Sets the sensor gain.

Parameters

gain	- sets the sensor gain [unitless]

Returns: void

void ciSigSimSensor::SetGain	(	int	sensorIdx,
		double	gain
	)

Description:: Sets the sensor gain.

Parameters

sensorIdx	- index in the sensor list of the sensor data
gain	- sets the sensor gain [unitless]

Returns: void

double ciSigSimSensor::GetGain ( )

Description:: Gets the sensor gain.

Returns: The sensor gain.

double ciSigSimSensor::GetGain ( int sensorIdx )

Description:: Gets the sensor gain.

Parameters

sensorIdx - index in the sensor list of the sensor data

Returns: The sensor gain.

void ciSigSimSensor::SetLevel ( double level )

Description:: Sets the sensor level.

Parameters

level - sets the sensor level [unitless]

Returns: void

void ciSigSimSensor::SetLevel	(	int	sensorIdx,
		double	level
	)

Description:: Sets the sensor level.

Parameters

sensorIdx	- index in the sensor list of the sensor data
level	- sets the sensor level [unitless]

Returns: void

double ciSigSimSensor::GetLevel ( )

Description:: Gets the sensor level.

Returns: The sensor level.

double ciSigSimSensor::GetLevel ( int sensorIdx )

Description:: Gets the sensor level.

Parameters

sensorIdx - index in the sensor list of the sensor data

Returns: The sensor level.

void ciSigSimSensor::setFOVDegrees	(	double	horz,
		double	vert
	)

Description:: Sets the sensor FOV in degrees.

Parameters

horz	- sets the horizontal FOV sample [deg]
vert	- sets the verticle FOV sample [deg]

Returns: void

void ciSigSimSensor::setFOVDegrees	(	int	sensorIdx,
		double	horz,
		double	vert
	)

Description:: Sets the sensor FOV in degrees.

Parameters

sensorIdx	- index in the sensor list of the sensor data
horz	- sets the horizontal FOV sample [deg]
vert	- sets the verticle FOV sample [deg]

Returns: void

void ciSigSimSensor::getFOVDegrees	(	double &	horz,
		double &	vert
	)

Description:: Gets the sensor FOV in degrees.

Parameters

horz	- returns the horizontal FOV sample [deg]
vert	- returns the verticle FOV sample [deg]

Returns: void

void ciSigSimSensor::getFOVDegrees	(	int	sensorIdx,
		double &	horz,
		double &	vert
	)

Description:: Gets the sensor FOV in degrees.

Parameters

sensorIdx	- index in the sensor list of the sensor data
horz	- returns the horizontal FOV sample [deg]
vert	- returns the verticle FOV sample [deg]

Returns: void

void ciSigSimSensor::SetFOV_NEDView	(	double	i,
		double	j,
		double	k
	)

Description:: Sets the FOV NED view position for the sensor.

Parameters

i	- sets the x component of the NED vector
j	- sets the y component of the NED vector
k	- sets the z component of the NED vector

Returns: void

Note: Also fills FRD_orientation based on desired ned_view with no roll.

void ciSigSimSensor::SetFOV_NEDView	(	int	sensorIdx,
		double	i,
		double	j,
		double	k
	)

Description:: Sets the FOV NED view position for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
i	- sets the x component of the NED vector
j	- sets the y component of the NED vector
k	- sets the z component of the NED vector

Returns: void

Note: Also fills FRD_orientation based on desired ned_view with no roll.

void ciSigSimSensor::GetFOV_NEDView	(	double &	i,
		double &	j,
		double &	k
	)

Description:: Gets the FOV NED view position for the sensor.

Parameters

i	- returns the x component of the NED vector
j	- returns the y component of the NED vector
k	- returns the z component of the NED vector

Returns: void

void ciSigSimSensor::GetFOV_NEDView	(	int	sensorIdx,
		double &	i,
		double &	j,
		double &	k
	)

Description:: Gets the FOV NED view position for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
i	- returns the x component of the NED vector
j	- returns the y component of the NED vector
k	- returns the z component of the NED vector

Returns: void

void ciSigSimSensor::SetFOVGeodetic	(	double	latitude,
		double	longitude,
		double	altitude
	)

Description:: Sets the geodetic FOV position for the sensor.

Parameters

latitude	- sets the latitude of the sensor [deg]
longitude	- sets the longitude of the sensor [deg]
altitude	- sets the altitude of the sensor [m]

Returns: void

Note: Also sets the geocentric location.

void ciSigSimSensor::SetFOVGeodetic	(	int	sensorIdx,
		double	latitude,
		double	longitude,
		double	altitude
	)

Description:: Sets the geodetic FOV position for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
latitude	- sets the latitude of the sensor [deg]
longitude	- sets the longitude of the sensor [deg]
altitude	- sets the altitude of the sensor [m]

Returns: void

Note: Also sets the geocentric location.

void ciSigSimSensor::GetFOVGeodetic	(	double &	latitude,
		double &	longitude,
		double &	altitude
	)

Description:: Gets the geodetic FOV position for the sensor.

Parameters

latitude	- returns the latitude of the sensor [deg]
longitude	- returns the longitude of the sensor [deg]
altitude	- returns the altitude of the sensor [m]

Returns: void

void ciSigSimSensor::GetFOVGeodetic	(	int	sensorIdx,
		double &	latitude,
		double &	longitude,
		double &	altitude
	)

Description:: Gets the geodetic FOV position for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
latitude	- returns the latitude of the sensor [deg]
longitude	- returns the longitude of the sensor [deg]
altitude	- returns the altitude of the sensor [m]

Returns: void

void ciSigSimSensor::setBandInfo	(	double	ax,
		double	bx,
		int	nBins
	)

Description:: Sets the spectral wave band information for the sensor.

Parameters

ax	- sets the lower band limit [um]
bx	- sets the upper band limit [um]
nBins	- sets the number of sample bins (dx = (bx - ax)/nBins)

Returns: void

void ciSigSimSensor::setBandInfo	(	int	sensorIdx,
		double	ax,
		double	bx,
		int	nBins
	)

Description:: Sets the spectral wave band information for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
ax	- sets the lower band limit [um]
bx	- sets the upper band limit [um]
nBins	- sets the number of sample bins (dx = (bx - ax)/nBins)

Returns: void

void ciSigSimSensor::setBandInfo	(	double	ax,
		double	bx,
		double	dx
	)

Description:: Sets the spectral wave band information for the sensor.

Parameters

ax	- sets the lower band limit [um]
bx	- sets the upper band limit [um]
dx	- sets the band sample interval [um]

Returns: void

void ciSigSimSensor::setBandInfo	(	int	sensorIdx,
		double	ax,
		double	bx,
		double	dx
	)

Description:: Sets the spectral wave band information for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
ax	- sets the lower band limit [um]
bx	- sets the upper band limit [um]
dx	- sets the band sample interval [um]

Returns: void

void ciSigSimSensor::getBandInfo	(	double &	ax,
		double &	bx,
		int &	nBins
	)

Description:: Gets the spectral wave band information for the sensor.

Parameters

ax	- returns the lower band limit [um]
bx	- returns the upper band limit [um]
nBins	- returns the number of sample bins (dx = (bx - ax)/nBins)

Returns: void

void ciSigSimSensor::getBandInfo	(	int	sensorIdx,
		double &	ax,
		double &	bx,
		int &	nBins
	)

Description:: Gets the spectral wave band information for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
ax	- returns the lower band limit [um]
bx	- returns the upper band limit [um]
nBins	- returns the number of sample bins (dx = (bx - ax)/nBins)

Returns: void

void ciSigSimSensor::getBandInfo	(	double &	ax,
		double &	bx,
		double &	dx
	)

Description:: Gets the spectral wave band information for the sensor.

Parameters

ax	- returns the lower band limit [um]
bx	- returns the upper band limit [um]
dx	- returns the band sample interval [um]

Returns: void

void ciSigSimSensor::getBandInfo	(	int	sensorIdx,
		double &	ax,
		double &	bx,
		double &	dx
	)

Description:: Gets the spectral wave band information for the sensor.

Parameters

sensorIdx	- index in the sensor list of the sensor data
ax	- returns the lower band limit [um]
bx	- returns the upper band limit [um]
dx	- returns the band sample interval [um]

Returns: void

SENSOR* ciSigSimSensor::GetSigSimSensor ( )

inline

Description:: Returns the pointer to the SigSim SENSOR array list. The pointer returned is a contiguous SigSim SENSOR array.

Returns: The current SENSOR pointer.

Note: The SENSOR pointer is temporary, and should not be stored.

References m_sigSimSensor.

int ciSigSimSensor::GetNumberOfSensors ( )

inline

Description:: Gets the number of sensors the SigSim SENSOR array list.

Returns: Number of sensors the SigSim SENSOR array list.

References m_numSensors.

bool ciSigSimSensor::archive ( char * filepath )

Description:: Saves the ciSigSimSensor object to file.

Parameters

filepath - complete path to the file

Returns: true if sucessful

bool ciSigSimSensor::serialize ( char * filepath )

Description:: Loads the ciSigSimSensor object from file.

Parameters

filepath - complete path to the file

Returns: true if sucessful

Member Data Documentation

SENSOR* ciSigSimSensor::m_sigSimSensor

private

Referenced by GetSigSimSensor().

int ciSigSimSensor::m_numSensors

private

Referenced by GetNumberOfSensors().

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

ciSigSimSensor.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation