Collaboration diagram for D4D GRAPH API Macro's Specification:

Macros
#define	_D4D_DECLARE_GRAPH_BEGIN(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)
	Macro that create the Graph object structure in memory including all substructures. More...

#define	D4D_DECLARE_GRAPH_TRACE(pData, clr, line, type)
	Macro that is used to add trace to graph definition. More...

#define	D4D_DECLARE_GRAPH_END()
	Macro that is used to end of graph definition. More...

#define	D4D_DECLARE_GRAPH_BEGIN(name, text, x, y, cx, cy, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)
	Macro that create the Graph object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_GRAPH_BEGIN(name, text, x, y, cx, cy, gx, gy, dataLen, fontId, lblFontId)
	Macro that create the Graph object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_RGRAPH_BEGIN(name, text, x, y, cx, cy, radius, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)
	Macro that create the rounded Graph object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RGRAPH_BEGIN(name, text, x, y, cx, cy, radius, gx, gy, dataLen, fontId, lblFontId)
	Macro that create the rounded Graph object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_GRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)
	Same as D4D_DECLARE_GRAPH_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_GRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, gx, gy, dataLen, fontId, lblFontId)
	Same as D4D_DECLARE_STD_GRAPH_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RGRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, radius, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)
	Same as D4D_DECLARE_RGRAPH_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RGRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, radius, gx, gy, dataLen, fontId, lblFontId)
	Same as D4D_DECLARE_STD_RGRAPH_BEGIN, but is created in RAM instead of the ROM memory. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define _D4D_DECLARE_GRAPH_BEGIN	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		gx,
		gy,
		dataLen,
		flags,
		pScheme,
		fontId,
		lblFontId,
		pOnNeedLblTxt,
		pUser,
		pOnValch,
		pOnUsrMsg
	)

Macro that create the Graph object structure in memory including all substructures.

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of graph object
text	- title text of graph
x	- coordination of graph in X axis
y	- coordination of graph in Y axis
cx	- size of graph in X axis (width)
cy	- size of graph in Y axis (height)
radius	- radius of corners
pMargin	- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
pRelations	- pointer to object relation array (Could be NULL)
gx	- count of grid lines in axis X
gy	- count of grid lines in axis Y
dataLen	- lenght of internal data buffer. This value extremly impact the memory consumption (memory = dataLen * cntOfTraces)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D GRAPH Defines masks of its specific behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
lblFontId	- Identification number of the used labels text font
pOnNeedLblTxt	- Pointer to the calll back function that is called when text is needed to draw a label D4D_GRAPH_ON_NEED_LABEL
pUser	- user data of button
pOnValch	- Pointer to an on-change user callback function D4D_GRAPH_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GRAPH structure, including the object data sub structure. Is used to define all properties of graph.

Definition at line 271 of file d4d_graph.h.

#define D4D_DECLARE_GRAPH_BEGIN	(	name,
		text,
		x,
		y,
		cx,
		cy,
		gx,
		gy,
		dataLen,
		flags,
		pScheme,
		fontId,
		lblFontId,
		pOnNeedLblTxt,
		pUser,
		pOnValch,
		pOnUsrMsg
	)

Macro that create the Graph object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of graph object
text	- title text of graph
x	- coordination of graph in X axis
y	- coordination of graph in Y axis
cx	- size of graph in X axis (width)
cy	- size of graph in Y axis (height)
gx	- count of grid lines in axis X
gy	- count of grid lines in axis Y
dataLen	- lenght of internal data buffer. This value extremly impact the memory consumption (memory = dataLen * cntOfTraces)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D GRAPH Defines masks of its specific behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
lblFontId	- Identification number of the used labels text font
pOnNeedLblTxt	- Pointer to the calll back function that is called when text is needed to draw a label D4D_GRAPH_ON_NEED_LABEL
pUser	- user data of button
pOnValch	- Pointer to an on-change user callback function D4D_GRAPH_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GRAPH structure, including the object data sub structure. Is used to define all properties of graph. Is used to define all properties of graph. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_GRAPH_BEGIN instead of this one.

Definition at line 353 of file d4d_graph.h.

#define D4D_DECLARE_GRAPH_BEGIN_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		gx,
		gy,
		dataLen,
		flags,
		pScheme,
		fontId,
		lblFontId,
		pOnNeedLblTxt,
		pUser,
		pOnValch,
		pOnUsrMsg
	)

Same as D4D_DECLARE_GRAPH_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 436 of file d4d_graph.h.

#define D4D_DECLARE_GRAPH_END ( )

Macro that is used to end of graph definition.

Note: This macro is used as a last declaration macro in Graph definition Here is an example demonstrating how to used it.
* D4D_GRAPH_VALUE my_traceData1[200];

* D4D_GRAPH_VALUE my_traceData2[200];

* D4D_DECLARE_STD_GRAPH_BEGIN(my_graph, D4D_DEFSTR("My Nice Graph"), 10, 10, 200, 150, 4, 3, 200, MY_FONT, MY_SMALL_FONT)

* D4D_DECLARE_GRAPH_TRACE(my_traceData1, D4D_WHITE, D4D_LINE_THIN, D4D_GRAPH_TRACE_TYPE_LINE)

* D4D_DECLARE_GRAPH_TRACE(my_traceData2, D4D_RED, D4D_LINE_THICK, D4D_GRAPH_TRACE_TYPE_DOT)

* D4D_DECLARE_GRAPH_END()

*

Definition at line 325 of file d4d_graph.h.

#define D4D_DECLARE_GRAPH_TRACE	(	pData,
		clr,
		line,
		type
	)

Macro that is used to add trace to graph definition.

Parameters

pData	- pointer to data buffer for this trace - it must have at least lenght "dataLen" from _D4D_DECLARE_GRAPH_BEGIN declaration
clr	- color of trace - D4D_COLOR
line	- line type - D4D_LINETYPE
type	- type of trace - D4D GRAPH Defines types of graph traces.

Note: This macro is used after the graph declaration to add new trace Here is an example demonstrating how to used it.
* D4D_GRAPH_VALUE my_traceData1[200];

* D4D_GRAPH_VALUE my_traceData2[200];

* D4D_DECLARE_STD_GRAPH_BEGIN(my_graph, D4D_DEFSTR("My Nice Graph"), 10, 10, 200, 150, 4, 3, 200, MY_FONT, MY_SMALL_FONT)

* D4D_DECLARE_GRAPH_TRACE(my_traceData1, D4D_WHITE, D4D_LINE_THIN, D4D_GRAPH_TRACE_TYPE_LINE)

* D4D_DECLARE_GRAPH_TRACE(my_traceData2, D4D_RED, D4D_LINE_THICK, D4D_GRAPH_TRACE_TYPE_DOT)

* D4D_DECLARE_GRAPH_END()

*

Definition at line 310 of file d4d_graph.h.

#define D4D_DECLARE_RGRAPH_BEGIN	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		gx,
		gy,
		dataLen,
		flags,
		pScheme,
		fontId,
		lblFontId,
		pOnNeedLblTxt,
		pUser,
		pOnValch,
		pOnUsrMsg
	)

Macro that create the rounded Graph object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of graph object
text	- title text of graph
x	- coordination of graph in X axis
y	- coordination of graph in Y axis
cx	- size of graph in X axis (width)
cy	- size of graph in Y axis (height)
radius	- radius of corners
gx	- count of grid lines in axis X
gy	- count of grid lines in axis Y
dataLen	- lenght of internal data buffer. This value extremly impact the memory consumption (memory = dataLen * cntOfTraces)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D GRAPH Defines masks of its specific behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
lblFontId	- Identification number of the used labels text font
pOnNeedLblTxt	- Pointer to the calll back function that is called when text is needed to draw a label D4D_GRAPH_ON_NEED_LABEL
pUser	- user data of button
pOnValch	- Pointer to an on-change user callback function D4D_GRAPH_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GRAPH structure, including the object data sub structure. Is used to define all properties of graph. Is used to define all properties of graph. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_GRAPH_BEGIN instead of this one.

Definition at line 405 of file d4d_graph.h.

#define D4D_DECLARE_RGRAPH_BEGIN_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		gx,
		gy,
		dataLen,
		flags,
		pScheme,
		fontId,
		lblFontId,
		pOnNeedLblTxt,
		pUser,
		pOnValch,
		pOnUsrMsg
	)

Same as D4D_DECLARE_RGRAPH_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 450 of file d4d_graph.h.

#define D4D_DECLARE_STD_GRAPH_BEGIN	(	name,
		text,
		x,
		y,
		cx,
		cy,
		gx,
		gy,
		dataLen,
		fontId,
		lblFontId
	)

Macro that create the Graph object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of graph object
text	- title text of graph
x	- coordination of graph in X axis
y	- coordination of graph in Y axis
cx	- size of graph in X axis (width)
cy	- size of graph in Y axis (height)
gx	- count of grid lines in axis X
gy	- count of grid lines in axis Y
dataLen	- lenght of internal data buffer. This value extremly impact the memory consumption (memory = dataLen * cntOfTraces)
fontId	- Identification number of the used title text font
lblFontId	- Identification number of the used labels text font

Note: This macro create complete D4D_GRAPH structure, including the object data sub structure. Is used to define all properties of graph. Is used to define all properties of graph. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_GRAPH_BEGIN instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 375 of file d4d_graph.h.

#define D4D_DECLARE_STD_GRAPH_BEGIN_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		gx,
		gy,
		dataLen,
		fontId,
		lblFontId
	)

Same as D4D_DECLARE_STD_GRAPH_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 442 of file d4d_graph.h.

#define D4D_DECLARE_STD_RGRAPH_BEGIN	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		gx,
		gy,
		dataLen,
		fontId,
		lblFontId
	)

Macro that create the rounded Graph object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of graph object
text	- title text of graph
x	- coordination of graph in X axis
y	- coordination of graph in Y axis
cx	- size of graph in X axis (width)
cy	- size of graph in Y axis (height)
radius	- radius of corners
gx	- count of grid lines in axis X
gy	- count of grid lines in axis Y
dataLen	- lenght of internal data buffer. This value extremly impact the memory consumption (memory = dataLen * cntOfTraces)
fontId	- Identification number of the used title text font
lblFontId	- Identification number of the used labels text font

Note: This macro create complete D4D_GRAPH structure, including the object data sub structure. Is used to define all properties of graph. Is used to define all properties of graph. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_GRAPH_BEGIN instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 428 of file d4d_graph.h.

#define D4D_DECLARE_STD_RGRAPH_BEGIN_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		gx,
		gy,
		dataLen,
		fontId,
		lblFontId
	)

Same as D4D_DECLARE_STD_RGRAPH_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 456 of file d4d_graph.h.

Macros

Detailed Description

Macro Definition Documentation