MityDSP Namespace Reference

Classes
class	tcBench
class	tcGuiButton
class	tcGuiCheckBox
class	tcGuiDisplay
class	tcGuiGenericGraph
class	tcGuiImage
class	tcGuiKnob
class	tcGuiLabel
class	tcGuiLamp
class	tcGuiListbox
struct	tsGuiRegion
class	tcGuiObject
class	tcGuiSlider
class	tcGuiSpinBox
class	tcPoint
class	tcSize
class	tcRect
class	tcGuiDspDisplay
class	tcFrameBench
class	tcGuiEvent
class	tcGuiFramework
struct	tsGraphAxisCfg
struct	tsGraphAxis
class	tcGraphAxis
class	tcGuiGraph
Typedefs
typedef void(*	BUTTON_PUSH_CB )(void *userptr, int userid)
typedef void(*	BUTTON_EVENT_CB )(void *userptr, int userid, teBtnEvent e)
typedef void(*	CHECKBOX_CB )(void *userptr, int userid, bool checked)
typedef void(*	KNOB_POSITION_CB )(void *userptr, int userid, int position)
typedef void(*	LISTBOX_SELECT_CB )(void *userptr, int userid, int selection)
typedef void(*	LISTBOX_MULTISELECT_CB )(void *userptr, int userid, int selection, bool selected)
typedef void(*	SLIDER_POSITION_CB )(void *userptr, int userid, int position)
typedef void(*	SPINBOX_SELECT_CB )(void *userptr, int userid, int selection)
typedef uint32	tsRgb
Enumerations
enum	teGuiLock { GUI_UNLOCKED, GUI_LOCKED, GUI_RELEASED }
enum	teGuiResult { GUI_ACCEPTED, GUI_REJECTED, GUI_NOMATCH }
enum	teBtnEvent { BTN_PUSH, BTN_CLICK, BTN_UP, BTN_DN }
enum	DISPLAY_STATUS { DISPLAY_NORMAL, DISPLAY_ERROR, DISPLAY_WARNING }
enum	LAMPSTATE {   LAMPSTATE_0 = 0, LAMPSTATE_1 = 1, LAMPSTATE_2 = 2, LAMPSTATE_3 = 3,   LAMPSTATE_OFF1 = 0, LAMPSTATE_ON1 = 1, LAMPSTATE_OFF2 = 2, LAMPSTATE_ON2 = 3 }
enum	teSpinBoxType { eeSpinBoxTypeHasStrings, eeSpinBoxTypeUserFill }
enum	teHorizontalAlignment { eeHLeft, eeHCenter, eeHRight }
enum	teVerticalAlignment { eeVTop, eeVCenter, eeVBottom }
enum	eeGuiEvent {   eeLeftDown, eeLeftUp, eeRightDown, eeRightUp,   eeMove, eeUnknown }
enum	eGraphAxisType { GRAPH_AXIS_LIN, GRAPH_AXIS_LOG }
enum	eGraphAxisLineSide { GRAPH_AXIS_LINE_LT, GRAPH_AXIS_LINE_RT }
Variables
const int	XML_BUFFSIZE = 1000
const int	MAX_XML_DEPTH = 10
const int	MAX_COLOR_DEFS = 256
const int	MAX_OFFSET_DEFS = 10000
const int	MAX_REGION_DEFS = 1024
const int	MAX_FONT_DEFS = 64
const int	MAX_FN_LENGTH = 128
const int	CHARS_PER_IMAGE = 94
const int	DSPY_DFLT_MAX_CHARS = 8
const int	GUI_SHIFT_KEY = 0x0001
const int	GUI_CNTRL_KEY = 0x0002
int	gnGguiLibMajor = 1
int	gnGguiLibMinor = 3
int	gnGguiLibBuild = 0
const char *	gpGguiLibStr = "MityDSP GGUI library version 1.3.0"
const char *	gpGguiLibDate = __DATE__
const char *	gpGguiLibTime = __TIME__
const uint32	GRAPH_AXIS_MAJOR = 0x00000001
	make a major axis tick
const uint32	GRAPH_AXIS_MINOR = 0x00000002
	make a minor axis tick
const uint32	GRAPH_AXIS_LINE = 0x00000004
	draw a line across plot field
const uint32	GRAPH_AXIS_LABEL = 0x00000008
	draw a text label at the position.

---

Detailed Description

Comment this in if you feel you need thread safety internal to the Display Class driver. This is very inefficient. Typically, application frameworks designate one thread that handles the graphics and drawing responsibilities, in which case serialization can be handled at the framework level (and far more efficiently).

---

Typedef Documentation

typedef void(* MityDSP::BUTTON_PUSH_CB)(void *userptr, int userid)

typedef void(* MityDSP::BUTTON_EVENT_CB)(void *userptr, int userid, teBtnEvent e)

typedef void(* MityDSP::CHECKBOX_CB)(void *userptr, int userid, bool checked)

typedef void(* MityDSP::KNOB_POSITION_CB)(void *userptr, int userid, int position)

This is the callback prototype for knob events.

Parameters:

	userptr	the user pointer set in tcGuiObject base class
	userid	the user id set in the constructor of the tcGuiObject base class
	position	the new position of the knob control.

typedef void(* MityDSP::LISTBOX_SELECT_CB)(void *userptr, int userid, int selection)

This is the callback prototype for single item listbox select events.

Parameters:

	userptr	tcGuiObject specified user pointer
	userid	tcGuiObject base identifier set in constructor
	selection	index of line selected, if < 0 no items selected

typedef void(* MityDSP::LISTBOX_MULTISELECT_CB)(void *userptr, int userid, int selection, bool selected)

This is the callback prototype for multi-item listbox select events. This capability is currently unused/untested for the MityDSP port.

Parameters:

	userptr	tcGuiObject specified user pointer
	userid	tcGuiObject base identifier set in constructor
	selection	TBD
	selected	TBD

typedef void(* MityDSP::SLIDER_POSITION_CB)(void *userptr, int userid, int position)

This callback prototype is used to get feedback information from a tcGuiSlider widget when the widget changes position.

Parameters:

	userptr	set in tcGuiObject base class method
	userid	tcGuiObject ID
	position	location of position

typedef void(* MityDSP::SPINBOX_SELECT_CB)(void *userptr, int userid, int selection)

typedef uint32 MityDSP::tsRgb

---

Enumeration Type Documentation

enum MityDSP::teGuiLock

Enumerator:

GUI_UNLOCKED	The GUI object was not locked.
GUI_LOCKED	The GUI object is locked.
GUI_RELEASED	The GUI object was locked, but not anymore.

enum MityDSP::teGuiResult

Enumerator:

GUI_ACCEPTED	The mouse event was accepted by an object.
GUI_REJECTED	The mouse event was rejected by an object.
GUI_NOMATCH	The mouse event not claimed by any object.

enum MityDSP::teBtnEvent

This enumeration describes the button events processed by the tcGuiButton class.

Enumerator:

BTN_PUSH	Button pushed (i.e. down from 1st click).
BTN_CLICK	Button releases (i.e. up inside the button, occurs simultaneously with old push callback).
BTN_UP	Button release because the mouse moved off the button.
BTN_DN	Button pushed because the mouse moved back over it.

enum MityDSP::DISPLAY_STATUS

This enumeration is used to describe the alert state of the tcGuiDisplay widget.

Enumerator:

DISPLAY_NORMAL	normal mode, no errors
DISPLAY_ERROR	warnings are present
DISPLAY_WARNING	an error condition is present

enum MityDSP::LAMPSTATE

Enumerator:

LAMPSTATE_0
LAMPSTATE_1
LAMPSTATE_2
LAMPSTATE_3
LAMPSTATE_OFF1
LAMPSTATE_ON1
LAMPSTATE_OFF2
LAMPSTATE_ON2

enum MityDSP::teSpinBoxType

This type def describes the mode of a tcGuiSpinBox widget.

Enumerator:

eeSpinBoxTypeHasStrings	Has strings, manages the selection, appears as rolling selection.
eeSpinBoxTypeUserFill	Does NOT have strings, application manages selection, appears as rolling selection.

enum MityDSP::teHorizontalAlignment

This enumeration is used for defining raw text alignment in the horizontal dimension.

Enumerator:

eeHLeft
eeHCenter
eeHRight

enum MityDSP::teVerticalAlignment

This enumeration is used for defining raw text alignment in the vertical dimension.

Enumerator:

eeVTop
eeVCenter
eeVBottom

enum MityDSP::eeGuiEvent

This enumeration represents the known system events that the tcGuiFramework class will pass to the ggui GUI library.

Enumerator:

eeLeftDown	left mouse button has been pressed
eeLeftUp	left mouse button has been released
eeRightDown	right mouse button has been pressed
eeRightUp	right mouse button has been released
eeMove	mouse has moved
eeUnknown	illegal event, but used for initialization

enum MityDSP::eGraphAxisType

This enumeration describes how numeric lines should be drawn for a given axis.

Enumerator:

GRAPH_AXIS_LIN	use linear scaling.
GRAPH_AXIS_LOG	use base 10 logarithmic scaling.

enum MityDSP::eGraphAxisLineSide

This enumeration is used to specify which side of a graph a Y axis should be rendered on.

Enumerator:

GRAPH_AXIS_LINE_LT	render on left side
GRAPH_AXIS_LINE_RT	render on right side

---

Variable Documentation

const int MityDSP::XML_BUFFSIZE = 1000

const int MityDSP::MAX_XML_DEPTH = 10

const int MityDSP::MAX_COLOR_DEFS = 256

const int MityDSP::MAX_OFFSET_DEFS = 10000

const int MityDSP::MAX_REGION_DEFS = 1024

const int MityDSP::MAX_FONT_DEFS = 64

const int MityDSP::MAX_FN_LENGTH = 128

const int MityDSP::CHARS_PER_IMAGE = 94

const int MityDSP::DSPY_DFLT_MAX_CHARS = 8

const int MityDSP::GUI_SHIFT_KEY = 0x0001

const int MityDSP::GUI_CNTRL_KEY = 0x0002

int MityDSP::gnGguiLibMajor = 1

MityDSP GGUI library major version number

int MityDSP::gnGguiLibMinor = 3

MityDSP GGUI library minor version number

int MityDSP::gnGguiLibBuild = 0

MityDSP GGUI library build version number

const char * MityDSP::gpGguiLibStr = "MityDSP GGUI library version 1.3.0"

MityDSP GGUI library version as a string.

const char * MityDSP::gpGguiLibDate = __DATE__

MityDSP GGUI library build date.

const char * MityDSP::gpGguiLibTime = __TIME__

MityDSP GGUI library build time.

const uint32 MityDSP::GRAPH_AXIS_MAJOR = 0x00000001

make a major axis tick

The flags below are used with the tsGraphAxisCfg array description.

const uint32 MityDSP::GRAPH_AXIS_MINOR = 0x00000002

make a minor axis tick

const uint32 MityDSP::GRAPH_AXIS_LINE = 0x00000004

draw a line across plot field

const uint32 MityDSP::GRAPH_AXIS_LABEL = 0x00000008

draw a text label at the position.