Collaboration diagram for D4D GAUGE API Functions Specification:

Functions
void	D4D_GaugSetValue (D4D_OBJECT_PTR pThis, D4D_GAUGE_VALUE value)
	The function sets the new value of gauge. More...

D4D_GAUGE_VALUE	D4D_GaugGetValue (D4D_OBJECT_PTR pThis)
	The function gets the current value of gauge. More...

void	D4D_GaugSetLimits (D4D_OBJECT_PTR pThis, const D4D_GAUGE_LIMITS *pLimits)
	The function sets the new limits values of gauge. More...

void	D4D_GaugGetLimits (D4D_OBJECT_PTR pThis, D4D_GAUGE_LIMITS *pLimits)
	The function gets the values of gauge limit structure. More...

void	D4D_GaugSetDir (D4D_OBJECT_PTR pThis, D4D_TREND trend)
	The function set the trend/direction of gauge. More...

D4D_TREND	D4D_GaugGetDir (D4D_OBJECT_PTR pThis)
	The function gets the trend/direction of gauge object. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

D4D_TREND D4D_GaugGetDir ( D4D_OBJECT_PTR pThis )

The function gets the trend/direction of gauge object.

Parameters

pThis - pointer to gauge object

Returns: current trend/direction of gauge object

Note: none

Definition at line 348 of file d4d_gauge.c.

void D4D_GaugGetLimits	(	D4D_OBJECT_PTR	pThis,
		D4D_GAUGE_LIMITS *	pLimits
	)

The function gets the values of gauge limit structure.

Parameters

pThis	- pointer to gauge object
pLimits	- the pointer to limit structure where will be stored the data of current using limit structure

Returns: none

Note: none

Definition at line 312 of file d4d_gauge.c.

D4D_GAUGE_VALUE D4D_GaugGetValue ( D4D_OBJECT_PTR pThis )

The function gets the current value of gauge.

Parameters

pThis - pointer to gauge object

Returns: currnet value of gauge object

Note: none

Definition at line 260 of file d4d_gauge.c.

void D4D_GaugSetDir	(	D4D_OBJECT_PTR	pThis,
		D4D_TREND	trend
	)

The function set the trend/direction of gauge.

Parameters

pThis	- pointer to gauge object
trend	- the new trend of gauge

Returns: none

Note: none

Definition at line 325 of file d4d_gauge.c.

Here is the call graph for this function:

void D4D_GaugSetLimits	(	D4D_OBJECT_PTR	pThis,
		const D4D_GAUGE_LIMITS *	pLimits
	)

The function sets the new limits values of gauge.

Parameters

pThis	- pointer to gauge object
pLimits	- pointer to defined gauge limits structure

Returns: none

Note: In limit structure is defined as range of input values as visible range of pointer angle

Definition at line 274 of file d4d_gauge.c.

Here is the call graph for this function:

void D4D_GaugSetValue	(	D4D_OBJECT_PTR	pThis,
		D4D_GAUGE_VALUE	value
	)

The function sets the new value of gauge.

Parameters

pThis	- pointer to gauge object
value	- input value, MUST fit into the range sets by D4D_GaugSetLimits

Returns: none

Note: none

Definition at line 234 of file d4d_gauge.c.

Here is the call graph for this function: