Inheritance diagram for ciPanel:

Public Types
enum	enumGridColumnAssignments { NAME = 0, VALUE }

Public Member Functions
	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.
bool	Create (wxWindow *parent, wxWindowID id=SYMBOL_CIPANEL_IDNAME, const wxPoint &pos=SYMBOL_CIPANEL_POSITION, const wxSize &size=SYMBOL_CIPANEL_SIZE, long style=SYMBOL_CIPANEL_STYLE)
	Creation.
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
void	OnOffsetSliderUpdated (wxCommandEvent &event)
	wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_OFFSET_SLIDER
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
virtual void	RuntimeSetup (bool readOnly=true)
virtual void	updatePanel ()
virtual void	initializePanel ()
virtual void	updateName (char *name)

Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?

Public Attributes
wxGrid *	m_gridCtrl
wxSlider *	m_sliderOffset

Protected Member Functions
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)

Protected Attributes
const int	m_nameColWidth
wxEvtHandler *	m_AppEvtHandler

Detailed Description

ciPanel class declaration

Member Enumeration Documentation

enum ciPanel::enumGridColumnAssignments

Description: Enumerates the grid column name assignments.

Enumerator:

NAME
VALUE

Constructor & Destructor Documentation

ciPanel::ciPanel ( )

Constructor.

ciPanel::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.

Parameters

wxWindow*	parent
wxEvtHandler	*appEvtHandler
wxWindowID	id
const	wxPoint& pos
const	wxSize& size
long	style

Member Function Documentation

bool ciPanel::Create	(	wxWindow *	parent,
		wxWindowID	id = `SYMBOL_CIPANEL_IDNAME`,
		const wxPoint &	pos = `SYMBOL_CIPANEL_POSITION`,
		const wxSize &	size = `SYMBOL_CIPANEL_SIZE`,
		long	style = `SYMBOL_CIPANEL_STYLE`
	)

Creation.

Parameters

wxWindow*	parent
wxWindowID	id
const	wxPoint& pos
const	wxSize& size
long	style

Returns: bool

Reimplemented in ciSensorPanel.

void ciPanel::CreateControls ( int gridColumns )

Creates the controls and sizers.

Parameters

int	gridColumns

void ciPanel::OnSize ( wxSizeEvent & event )

Creates the controls and sizers.

wxEVT_SIZE event handler for ID_DIALOG_BASE_PANEL

Parameters

wxSizeEvent& event

void ciPanel::OnGridColSize ( wxGridSizeEvent & event )

wxEVT_GRID_COL_SIZE event handler for ID_GRID

Parameters

wxGridSizeEvent& event

void ciPanel::OnOffsetSliderUpdated ( wxCommandEvent & event )

wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_OFFSET_SLIDER

Parameters

wxCommandEvent& event

Reimplemented in ciSensorPanel.

wxBitmap ciPanel::GetBitmapResource ( const wxString & name )

Retrieves bitmap resources.

Parameters

const wxString& name

Returns: wxBitmap

wxIcon ciPanel::GetIconResource ( const wxString & name )

Retrieves icon resources.

Parameters

const wxString& name

Returns: wxIcon

static bool ciPanel::ShowToolTips ( )

static

Should we show tooltips?

Returns: static bool

virtual void ciPanel::RuntimeSetup ( bool readOnly = true )

virtual

Description:: Prepares the grid panel for runtime operation. By overriding this function, cells in the "Value" column can be made "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

Note: Expects to be overridden.

virtual void ciPanel::updatePanel ( )

virtual

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

Returns: void

Note: Expects to be overridden.

Reimplemented in ciSensorPanel.

virtual void ciPanel::initializePanel ( )

virtual

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 in ciSensorPanel.

virtual void ciPanel::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 in ciSensorPanel.

virtual void ciPanel::updateCheckboxCell	(	int	row,
		int	col,
		bool	check
	)

protectedvirtual

Description:: Updates the status of a checkbox grid cell.

Parameters

row	- row of the selected cell
col	- column of the selected cell
check	- new boolean value for the cell

Returns: void

virtual bool ciPanel::getCheckboxCell	(	int	row,
		int	col
	)

protectedvirtual

Description:: Gets the status of a checkbox grid cell.

Parameters

row	- row of the selected cell
col	- column of the selected cell

Returns: true or false - the checked status of the cell

virtual double ciPanel::updateDoubleCell	(	int	row,
		int	col,
		double	value,
		double	upper = `1000000`,
		double	lower = `-10000`
	)

protectedvirtual

Description:: Updates a cell that contains a double variable type.

Parameters

row	- row of the selected cell
col	- column of the selected cell
value	- new double value for the cell
defaultValue	- value to default to if the value if outside of the limits - optional and defaults to 0
upper	- upper limit of the value
lower	- lower limit of the value

Returns: double - final value of the cell

virtual bool ciPanel::validFileCheck	(	char *	fileName,
		char *	fileType
	)

protectedvirtual

Parameters

char*	fileName
char*	fileType

Returns: virtual bool

virtual double ciPanel::getDoubleCell	(	int	row,
		int	col
	)

protectedvirtual

Description:: Gets the value of a cell with a double variable type.

Parameters

row	- row of the selected cell
col	- column of the selected cell

Returns: double - the value of the cell

int ciPanel::getSampleChoiceHandler ( )

protected

Description:: Gets the choice selection from the dropdown grid control.

Returns: integer index of the choice selected from the dropdown grid control.

Note: Since wxWidgets kind of goofed on the implementation of the dropdown control, this method should be added for each dropdown grid control.

void ciPanel::setSampleChoiceHandler ( int sel )

protected

Description:: Sets the choice selection from the dropdown grid control.

Parameters

sel	- the value to set the dropdown control selection

Returns: void

Note: Since wxWidgets kind of goofed on the implementation of the dropdown control, this method should be added for each dropdown grid control.

Member Data Documentation

wxGrid* ciPanel::m_gridCtrl

wxSlider* ciPanel::m_sliderOffset

const int ciPanel::m_nameColWidth

protected

wxEvtHandler* ciPanel::m_AppEvtHandler

protected

The application event handler.

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

ciPanel.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation