Inheritance diagram for ciSensorPanel:

Public Types
enum	GridRowAssignments { SENSOR_NAME = 0, LOWER_BAND_LIMIT, UPPER_BAND_LIMIT, NUM_BAND_INTERVALS, HORIZONTAL_FOV, VERTICAL_FOV, HORIZONTAL_SAMPLES, VERTICAL_SAMPLES, SAMPLE_SCALE, UPPER_TEMPERATURE_LIMIT, LOWER_TEMPERATURE_LIMIT, MAX_LIGHT_LEVEL, USE_AUTOMATIC_RADIANCE, USE_TRACKFILE, TRACKFILE, LATITUDE, LONGITUDE, ALTITUDE, HEADING, PITCH, ROLL, GRID_ROWS }
Public Types inherited from ciPanel
enum	enumGridColumnAssignments { NAME = 0, VALUE }

Public Member Functions
virtual void	OnGridCellChange (wxGridEvent &event)
	wxEVT_GRID_CELL_CHANGE event handler for ID_SENSORGRID
virtual void	OnGridLeftDClick (wxGridEvent &event)
	wxEVT_GRID_CELL_LEFT_DCLICK event handler for ID_SENSORGRID
void	OnOffsetSliderUpdated (wxCommandEvent &event)
	wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_OFFSET_SLIDER
virtual ciSensor	getData ()
virtual void	setData (ciSensor sensorData)
virtual void	SetActive (bool isActive)
virtual bool	GetActive ()
virtual bool	Create (wxWindow *parent, wxWindowID id=SYMBOL_SENSORPANEL_IDNAME, const wxPoint &pos=SYMBOL_SENSORPANEL_POSITION, const wxSize &size=SYMBOL_SENSORPANEL_SIZE, long style=SYMBOL_SENSORPANEL_STYLE)
virtual void	CreateControls ()
virtual void	updateName (char *name)
void	runtimeSetup (bool readOnly=true)
virtual void	updateSensor ()
void	setIndex (int index)
int	getIndex ()
virtual void	updatePanel ()
void	copyManipulatorCoord ()
void	setRGBColor (int color)
int	getRGBColor ()
	ciSensorPanel ()
	construction
virtual	~ciSensorPanel ()
	destruction
	ciSensorPanel (wxWindow parent, wxEvtHandler appEvtHandler=NULL, wxWindowID id=SYMBOL_SENSORPANEL_IDNAME, const wxPoint &pos=SYMBOL_SENSORPANEL_POSITION, const wxSize &size=SYMBOL_SENSORPANEL_SIZE, long style=SYMBOL_SENSORPANEL_STYLE)
Public Member Functions inherited from ciPanel
	ciPanel ()
	Constructor.
	ciPanel (wxWindow parent, wxEvtHandler appEvtHandler=NULL, wxWindowID id=SYMBOL_CIPANEL_IDNAME, const wxPoint &pos=SYMBOL_CIPANEL_POSITION, const wxSize &size=SYMBOL_CIPANEL_SIZE, long style=SYMBOL_CIPANEL_STYLE)
	Constructor.
void	CreateControls (int gridColumns)
	Creates the controls and sizers.
void	OnSize (wxSizeEvent &event)
	Creates the controls and sizers.
void	OnGridColSize (wxGridSizeEvent &event)
	wxEVT_GRID_COL_SIZE event handler for ID_GRID
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
virtual void	RuntimeSetup (bool readOnly=true)

Public Attributes
ciSensor	m_sensorData
Public Attributes inherited from ciPanel
wxGrid *	m_gridCtrl
wxSlider *	m_sliderOffset

Protected Member Functions
void	hsViewerUpdate (wxCommandEvent &event)
virtual void	initializePanel ()
Protected Member Functions inherited from ciPanel
virtual void	updateCheckboxCell (int row, int col, bool check)
virtual bool	getCheckboxCell (int row, int col)
virtual double	updateDoubleCell (int row, int col, double value, double upper=1000000, double lower=-10000)
virtual bool	validFileCheck (char fileName, char fileType)
virtual double	getDoubleCell (int row, int col)
int	getSampleChoiceHandler ()
void	setSampleChoiceHandler (int sel)

Private Attributes
const int	m_nameColWidth
double	m_lowerBandLimit
double	m_upperBandLimit
wxSlider *	m_sliderOffset

Additional Inherited Members
Static Public Member Functions inherited from ciPanel
static bool	ShowToolTips ()
	Should we show tooltips?
Protected Attributes inherited from ciPanel
const int	m_nameColWidth
wxEvtHandler *	m_AppEvtHandler

Detailed Description

ciSensorPanel class declaration

Member Enumeration Documentation

enum ciSensorPanel::GridRowAssignments

Description: Enumerates the grid row name assignments.

Enumerator:

SENSOR_NAME
LOWER_BAND_LIMIT
UPPER_BAND_LIMIT
NUM_BAND_INTERVALS
HORIZONTAL_FOV
VERTICAL_FOV
HORIZONTAL_SAMPLES
VERTICAL_SAMPLES
SAMPLE_SCALE
UPPER_TEMPERATURE_LIMIT
LOWER_TEMPERATURE_LIMIT
MAX_LIGHT_LEVEL
USE_AUTOMATIC_RADIANCE
USE_TRACKFILE
TRACKFILE
LATITUDE
LONGITUDE
ALTITUDE
HEADING
PITCH
ROLL
GRID_ROWS

Constructor & Destructor Documentation

ciSensorPanel::ciSensorPanel ( )

construction

virtual ciSensorPanel::~ciSensorPanel ( )

virtual

destruction

ciSensorPanel::ciSensorPanel	(	wxWindow *	parent,
		wxEvtHandler *	appEvtHandler = `NULL`,
		wxWindowID	id = `SYMBOL_SENSORPANEL_IDNAME`,
		const wxPoint &	pos = `SYMBOL_SENSORPANEL_POSITION`,
		const wxSize &	size = `SYMBOL_SENSORPANEL_SIZE`,
		long	style = `SYMBOL_SENSORPANEL_STYLE`
	)

Description:: Constructor, creating a scenario panel.

Parameters

parent	- Parent window. Must not be NULL.
appEvtHandler	- pointer to the application's event handler. Must be defined if the panel is to talk to the app.
id	- Window identifier. A value of -1 indicates a default value.
pos	- Window position.
size	- Window size. If the default size (-1, -1) is specified then the window is sized appropriately.
style	- Window style. See wxTreeCtrl.

Member Function Documentation

virtual void ciSensorPanel::OnGridCellChange ( wxGridEvent & event )

virtual

wxEVT_GRID_CELL_CHANGE event handler for ID_SENSORGRID

Parameters

wxGridEvent& event

virtual void ciSensorPanel::OnGridLeftDClick ( wxGridEvent & event )

virtual

wxEVT_GRID_CELL_LEFT_DCLICK event handler for ID_SENSORGRID

Parameters

wxGridEvent& event

void ciSensorPanel::OnOffsetSliderUpdated ( wxCommandEvent & event )

wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_OFFSET_SLIDER

Parameters

wxCommandEvent& event

Reimplemented from ciPanel.

virtual ciSensor ciSensorPanel::getData ( )

inlinevirtual

Description:: Gets the sensor data.

Returns: The ciSensor sensor data object in it's current state.

See Also: SetSensorData()

References m_sensorData.

virtual void ciSensorPanel::setData ( ciSensor sensorData )

virtual

Description:: Sets the sensor data.

Parameters

sensorData - the new sensor data object.

See Also: GetSensorData()

virtual void ciSensorPanel::SetActive ( bool isActive )

virtual

Description:: Sets the state (active or inactive) for the sensor object.

Parameters

isActive - new state (active or inactive) for the sensor.

Returns: void.

virtual bool ciSensorPanel::GetActive ( )

virtual

Description:: Gets the state (active or inactive) for the sensor object.

Returns: The current state (active or inactive) of the sensor object.

virtual bool ciSensorPanel::Create	(	wxWindow *	parent,
		wxWindowID	id = `SYMBOL_SENSORPANEL_IDNAME`,
		const wxPoint &	pos = `SYMBOL_SENSORPANEL_POSITION`,
		const wxSize &	size = `SYMBOL_SENSORPANEL_SIZE`,
		long	style = `SYMBOL_SENSORPANEL_STYLE`
	)

virtual

Description:: Overridden wxWidgets method. Creats a wxWidgets window.

Parameters

parent	- Parent window. Must not be NULL.
id	- Window identifier. A value of -1 indicates a default value.
pos	- Window position.
size	- Window size. If the default size (-1, -1) is specified then the window is sized appropriately.
style	- Window style. See wxTreeCtrl.

Returns: true if successful.

Reimplemented from ciPanel.

virtual void ciSensorPanel::CreateControls ( )

virtual

Description:: Overridden wxWidgets method. Creates the grid control and sets up the initial grid values.

Returns: void.

virtual void ciSensorPanel::updateName ( char * name )

virtual

Description:: Forces the parent window to update the name provided to the tree control.

Parameters

name	- The object's name.

Returns: void.

Reimplemented from ciPanel.

void ciSensorPanel::runtimeSetup ( bool readOnly = true )

Description:: Prepares the grid panel for runtime operation by making select cells in the "Value" column "read only", thus preventing accidental modification of data during a scenario run.

Parameters

readOnly - if true, disables select cells, making them "read only". If false, enables the cells.

Returns: void

virtual void ciSensorPanel::updateSensor ( )

virtual

Description:: Forces the parent window to update the sensor based on changed data.

Returns: void.

void ciSensorPanel::setIndex ( int index )

inline

Description:: Sets the index for the sensor. Useful to index into an sensor list later.

Returns: void.

References m_sensorData, and ciSensor::setIndex().

int ciSensorPanel::getIndex ( )

inline

Description:: Gets the index for the sensor. Useful to index into an sensor list later.

Returns: void.

References ciSensor::getIndex(), and m_sensorData.

virtual void ciSensorPanel::updatePanel ( )

virtual

Description:: Updates the data values in the panel grid.

Returns: void

Reimplemented from ciPanel.

void ciSensorPanel::copyManipulatorCoord ( )

Description:: copies the Sensor coordinates from the interface to the front panel

Returns: void

void ciSensorPanel::setRGBColor ( int color )

inline

Parameters

int color

References m_sensorData, and ciSensor::setRGBColor().

int ciSensorPanel::getRGBColor ( )

inline

Returns: int

References ciSensor::getRGBColor(), and m_sensorData.

void ciSensorPanel::hsViewerUpdate ( wxCommandEvent & event )

protected

Description:: Updates the Hyperspectral Viewer mode

Returns: void

virtual void ciSensorPanel::initializePanel ( )

protectedvirtual

Description:: Initializes the content in the "Name" column and sets up custom grid controls (i.e, checkboxes and dropdown controls.

Returns: void

Note: Expects to be overridden.

Reimplemented from ciPanel.

Member Data Documentation

ciSensor ciSensorPanel::m_sensorData

Singular instance of a ciSensor object.

Referenced by getData(), getIndex(), getRGBColor(), setIndex(), and setRGBColor().

const int ciSensorPanel::m_nameColWidth

private

double ciSensorPanel::m_lowerBandLimit

private

double ciSensorPanel::m_upperBandLimit

private

wxSlider* ciSensorPanel::m_sliderOffset

private

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

ciSensorPanel.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation