Histogram Class Reference

Histogram graphics element. More...

#include <hV_Graphics.h>

Inheritance diagram for Histogram:

Collaboration diagram for Histogram:

Public Member Functions
	Histogram (Graphics *graphics)
	Constructor.
void	dDefine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, int32_t valueMin, int32_t valueMax, int32_t unit=1, uint16_t marksX=0, uint16_t sectionsY=4, bool continous=false, uint16_t valueColour=myColours.black)
	Define the graphic, vector coordinates.
void	define (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, int32_t valueMin, int32_t valueMax, int32_t unit=1, uint16_t marksX=0, uint16_t sectionsY=4, bool continous=false, uint16_t valueColour=myColours.black)
	Define the graphic, rectangle coordinates.
void	draw (int32_t value)
	Update the graphic.
void	setStep (uint16_t step=1)
	Set the x-axis step.
Public Member Functions inherited from mtgPanel
	mtgPanel (Graphics *graphics)
	Constructor.

Detailed Description

Histogram graphics element.

Hitogram displays a time-based histogram

Constructor & Destructor Documentation

Histogram()

Histogram::Histogram

(

Graphics *

graphics

)

Constructor.

Parameters

graphics

&graphics to which the element belongs

Member Function Documentation

dDefine()

void Histogram::dDefine	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		int32_t	valueMin,
		int32_t	valueMax,
		int32_t	unit = 1,
		uint16_t	marksX = 0,
		uint16_t	sectionsY = 4,
		bool	continous = false,
		uint16_t	valueColour = myColours.black )

Define the graphic, vector coordinates.

Parameters

screen	&screen to which the graphic belongs
x0	point coordinate, x-axis
y0	point coordinate, y-axis
dx	length, x-axis
dy	height, y-axis
valueMin	minimum value for measures, already multiplied by unit
valueMax	maximum value for measures, already multiplied by unit
unit	multiplier for all values, default = 1, 10 or 100
marksX	grid on the x or time axis every specified number measures, default = 0 = no grid
sectionsY	number of sections on the y axis, default = 4, 0 = no grid
continous	true = keep previous measures, default = false = over-write
valueColour	16-bit colour for measures, default = black, optional

More: Coordinates, Colours, Value

define()

void Histogram::define	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	x2,
		uint16_t	y2,
		int32_t	valueMin,
		int32_t	valueMax,
		int32_t	unit = 1,
		uint16_t	marksX = 0,
		uint16_t	sectionsY = 4,
		bool	continous = false,
		uint16_t	valueColour = myColours.black )

Define the graphic, rectangle coordinates.

Parameters

screen	&screen to which the graphic belongs
x1	top left coordinate, x-axis
y1	top left coordinate, y-axis
x2	bottom right coordinate, x-axis
y2	bottom right coordinate, y-axis
valueMin	minimum value for measures, already multiplied by unit
valueMax	maximum value for measures, already multiplied by unit
unit	multiplier for all values, default = 1, 10 or 100
marksX	grid on the x or time axis every specified number measures, default = 0 = no grid
sectionsY	number of sections on the y axis, default = 4, 0 = no grid
continous	true = keep previous measures, default = false = over-write
valueColour	16-bit colour for measures, default = black, optional

More: Coordinates, Colours, Value

draw()

void Histogram::draw

(

int32_t

value

)

Update the graphic.

Parameters

value

new measure, already multiplied by unit

Note

If value = 1234 with unit = 100, actual value is 1234/100 = 12.34

More: Value

setStep()

void Histogram::setStep

(

uint16_t

step = 1

)

Set the x-axis step.

Parameters

step	step between two valuesn, x-axis, default = 1

---

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

• hV_Graphics.h