Collaboration diagram for D4D GRAPH API Functions Specification:

Functions
D4D_BOOL	D4D_GraphAddTraceData (D4D_OBJECT_PTR pObj, D4D_INDEX trace_ix, D4D_GRAPH_VALUE value)
	The function add new data to one trace. More...

void	D4D_GraphAddTracesData (D4D_OBJECT_PTR pObj, D4D_GRAPH_VALUE *pValues)
	The function add new data to all traces. More...

void	D4D_GraphClearAll (D4D_OBJECT_PTR pObj)
	The function clears all internal data of graph object. More...

LWord	D4D_GraphGetSampleIndex (D4D_OBJECT_PTR pObj)
	The function returns the current data sample index. More...

D4D_COOR	D4D_GraphGetSizeX (D4D_OBJECT_PTR pObj)
	The function returns the size of graph traces in axis X. More...

D4D_BOOL	D4D_GraphSetScaleX (D4D_OBJECT_PTR pObj, Byte mul, Byte div)
	Function sets the new scale of axis X of the graph. More...

D4D_BOOL	D4D_GraphSetDataWidth (D4D_OBJECT_PTR pObj, D4D_INDEX samples)
	Function sets the new scale of the axis X of the graph. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

D4D_BOOL D4D_GraphAddTraceData	(	D4D_OBJECT_PTR	pObj,
		D4D_INDEX	trace_ix,
		D4D_GRAPH_VALUE	value
	)

The function add new data to one trace.

Parameters

pObj	- pointer to graph object
trace_ix	- index of trace to add data
value	- new data to trace

Returns: none

Note: In case of more traces is used in graph, all other traces are updated with their last value.

Definition at line 592 of file d4d_graph.c.

Here is the call graph for this function:

void D4D_GraphAddTracesData	(	D4D_OBJECT_PTR	pObj,
		D4D_GRAPH_VALUE *	pValues
	)

The function add new data to all traces.

Parameters

pObj	- pointer to graph object
pValues	- array of new data for all traces (it should has same lenght as is traces count)

Returns: none

Note: This is preffered way how to add data to all traces at ones

Definition at line 655 of file d4d_graph.c.

Here is the call graph for this function:

void D4D_GraphClearAll ( D4D_OBJECT_PTR pObj )

The function clears all internal data of graph object.

Parameters

pObj	- pointer to graph object

Returns: none

Note: This function is used to restart graph object

Definition at line 694 of file d4d_graph.c.

Here is the call graph for this function:

LWord D4D_GraphGetSampleIndex ( D4D_OBJECT_PTR pObj )

The function returns the current data sample index.

Parameters

pObj	- pointer to graph object

Returns: data sample counter value

Note: Each add data function incremeant the 32-bit variable of sample count and this function returns the current value

Definition at line 711 of file d4d_graph.c.

D4D_COOR D4D_GraphGetSizeX ( D4D_OBJECT_PTR pObj )

The function returns the size of graph traces in axis X.

Parameters

pObj	- pointer to graph object

Returns: width of active part of graph

Note: none

Definition at line 722 of file d4d_graph.c.

Here is the call graph for this function:

D4D_BOOL D4D_GraphSetDataWidth	(	D4D_OBJECT_PTR	pObj,
		D4D_INDEX	samples
	)

Function sets the new scale of the axis X of the graph.

Parameters

pObj	- pointer to graph object
samples	- a count of samples shown on the graph

Returns: result of operation, true if it was executed correctly, false if not

Note: Function sets the new scale of the axis X of the graph. It allows setting up a graph object to show more or less samples of a graph active area, than is native to axis X. The scale of axis X sets-up by the count of the shown samples. To set up a new scale, D4D_GraphSetScaleX can be used too.

Definition at line 764 of file d4d_graph.c.

Here is the call graph for this function:

D4D_BOOL D4D_GraphSetScaleX	(	D4D_OBJECT_PTR	pObj,
		Byte	mul,
		Byte	div
	)

Function sets the new scale of axis X of the graph.

Parameters

pObj	- pointer to graph object
mul	- multiplier of the scale of axis X
div	- divider of the scale of axis X

Returns: result of operation, true if it was executed correctly, false if not

Note: It allows to set up a graph object to show more or less samples of the graph active area, than is native to axis X. The scale of axis X is set-up by the ratio of input parameters. To set-up a new scale another function D4D_GraphSetDataWidth can be used.

Definition at line 738 of file d4d_graph.c.

Here is the call graph for this function: