Skip to main content
Version: 4.16

DataGraphWrapAndClear

The DataGraphWrapAndClear will show new points progressing across the graph. Once the graph is filled, the next point added will cause the graph to be cleared and a new graph will slowly be created as new values are added.

Inherits from: AbstractDataGraphWithY, AbstractDataGraph, Container, Drawable

Inherited by: GraphWrapAndClear< CAPACITY >

Public Functions#

DataGraphWrapAndClear(int16_t capacity, int * values)
Initializes a new instance of the DataGraphWrapAndOverwrite class.
virtual int32_tindexToGlobalIndex(int16_t index) const
Convert an index to global index.

Protected Functions#

virtual int16_taddValue(int value)
Adds a value to the internal data array and keeps track of when graph points, graph axis and the entire graph needs to be redrawn (invalidated).
virtual voidbeforeAddValue()
This function is called before a new value (data point) is added.

Additional inherited members#

Public Functions inherited from AbstractDataGraphWithY#

AbstractDataGraphWithY(int16_t capacity, int * values)
Initializes a new instance of the AbstractDataGraphWithY class.
int16_taddDataPoint(float y)
Adds a new data point to the end of the graph.
int16_taddDataPoint(int y)
Adds a new data point to the end of the graph.
virtual intgetGraphRangeXMax() const
Gets the maximum x coordinate for the graph.
virtual intgetGraphRangeXMin() const
Gets the minimum x coordinate for the graph.
virtual floatgetGraphRangeYMaxAsFloat() const
Gets maximum y coordinate for the graph.
virtual intgetGraphRangeYMaxAsInt() const
Gets maximum y coordinate for the graph.
virtual floatgetGraphRangeYMinAsFloat() const
Gets minimum y coordinate for the graph.
virtual intgetGraphRangeYMinAsInt() const
Gets minimum y coordinate for the graph.
virtual floatgetXAxisOffsetAsFloat() const
Get x coordinate axis offset value.
virtual intgetXAxisOffsetAsInt() const
Get x coordinate axis offset value.
virtual floatgetXAxisScaleAsFloat() const
Get x coordinate axis scale value.
virtual intgetXAxisScaleAsInt() const
Get x coordinate axis scale value.
virtual voidsetGraphRangeX(int min, int max)
Sets minimum and maximum x coordinates for the graph.
virtual voidsetGraphRangeY(float min, float max)
Sets minimum and maximum y coordinates for the graph.
virtual voidsetGraphRangeY(int min, int max)
Sets minimum and maximum y coordinates for the graph.
voidsetGraphRangeYAuto(bool showXaxis =true, int margin =0)
Automatic adjust min and max y coordinate to show entire graph.
virtual voidsetScale(int scale)
Sets a scaling factor to be multiplied on each added element.
virtual voidsetXAxisOffset(float offset)
Set x coordinate axis offset value.
virtual voidsetXAxisOffset(int offset)
Set x coordinate axis offset value.
virtual voidsetXAxisScale(float scale)
Set x coordinate axis scale value.
virtual voidsetXAxisScale(int scale)
Set x coordinate axis scale value.

Protected Functions inherited from AbstractDataGraphWithY#

int16_taddDataPointScaled(int y)
Same as addDataPoint(int) except the passed argument is assumed scaled.
virtual intgetGraphRangeYMaxScaled() const
Gets maximum y coordinate for the graph.
virtual intgetGraphRangeYMinScaled() const
Gets minimum y coordinate for the graph.
virtual intgetXAxisOffsetScaled() const
Get x axis offset as a scaled value.
virtual intgetXAxisScaleScaled() const
Get x axis scale as a scaled value.
virtual intindexToDataPointXScaled(int16_t index) const
Same as indexToDataPointXAsInt(int16_t) except the returned value is left scaled.
virtual intindexToDataPointYScaled(int16_t index) const
Same as indexToDataPointYAsInt(int16_t) except the returned value is left scaled.
virtual CWRUtil::Q5indexToScreenXQ5(int16_t index) const
Gets screen x coordinate for a specific data point added to the graph.
virtual CWRUtil::Q5indexToScreenYQ5(int16_t index) const
Gets screen y coordinate for a specific data point added to the graph.
virtual int16_trealIndex(int16_t index) const
Get the real index in the yValues array of the given index.
virtual voidsetGraphRangeYScaled(int min, int max)
Same as setGraphRangeY(int,int) except the passed arguments are assumed scaled.
virtual voidsetXAxisOffsetScaled(int offset)
Set x coordinate axis offset value with a pre-scaled offset value.
virtual voidsetXAxisScaleScaled(int scale)
Set x coordinate axis scale value using a pre-scaled value.
virtual CWRUtil::Q5valueToScreenXQ5(int x) const
Gets screen x coordinate for an absolute value.
virtual CWRUtil::Q5valueToScreenYQ5(int y) const
Gets screen y coordinate for an absolute value.
virtual boolxScreenRangeToIndexRange(int16_t xLo, int16_t xHi, int16_t & indexLow, int16_t & indexHigh) const
Gets index range for screen x coordinate range taking the current graph range into account.

Protected Attributes inherited from AbstractDataGraphWithY#

uint32_tdataCounter
The data counter of how many times addDataPoint() has been called.
intxOffset
The x axis offset (real value of data point at index 0)
intxScale
The x axis scale (increment between two data points)
int *yValues
The values of the graph.

Public Classes inherited from AbstractDataGraph#

classGraphClickEvent
An object of this type is passed with each callback that is sent when the graph is clicked.
classGraphDragEvent
An object of this type is passed with each callback that is sent when the graph is dragged.

Public Functions inherited from AbstractDataGraph#

AbstractDataGraph(int16_t capacity)
Initializes a new instance of the AbstractDataGraph class.
voidaddBottomElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area below the graph.
voidaddGraphElement(AbstractGraphElement & d)
Adds a graph element which will display the graph.
voidaddLeftElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area to the left of the graph.
voidaddRightElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area to the right of the graph.
voidaddTopElement(AbstractGraphDecoration & d)
Adds an element to be shown in the area above the graph.
virtual voidclear()
Clears the graph to its blank/initial state.
uint8_tgetAlpha() const
Gets the current alpha value of the widget.
int16_tgetGapBeforeIndex() const
Gets gap before index as set using setGapBeforeIndex().
int16_tgetGraphAreaHeight() const
Gets graph area height.
int16_tgetGraphAreaHeightIncludingPadding() const
Gets graph area height including padding (but not margin).
int16_tgetGraphAreaMarginBottom() const
Gets graph margin bottom.
int16_tgetGraphAreaMarginLeft() const
Gets graph margin left.
int16_tgetGraphAreaMarginRight() const
Gets graph margin right.
int16_tgetGraphAreaMarginTop() const
Gets graph margin top.
int16_tgetGraphAreaPaddingBottom() const
Gets graph area padding bottom.
int16_tgetGraphAreaPaddingLeft() const
Gets graph area padding left.
int16_tgetGraphAreaPaddingRight() const
Gets graph area padding right.
int16_tgetGraphAreaPaddingTop() const
Gets graph area padding top.
int16_tgetGraphAreaWidth() const
Gets graph area width.
int16_tgetGraphAreaWidthIncludingPadding() const
Gets graph area width including padding (but not margin).
virtual intgetGraphRangeXMax() const =0
Gets the maximum x coordinate for the graph.
virtual intgetGraphRangeXMin() const =0
Gets the minimum x coordinate for the graph.
virtual floatgetGraphRangeYMaxAsFloat() const =0
Gets maximum y coordinate for the graph.
virtual intgetGraphRangeYMaxAsInt() const =0
Gets maximum y coordinate for the graph.
virtual floatgetGraphRangeYMinAsFloat() const =0
Gets minimum y coordinate for the graph.
virtual intgetGraphRangeYMinAsInt() const =0
Gets minimum y coordinate for the graph.
int16_tgetMaxCapacity() const
Gets the capacity (max number of points) of the graph.
virtual boolgetNearestIndexForScreenX(int16_t x, int16_t & index) const
Gets graph index nearest to the given screen x coordinate.
virtual boolgetNearestIndexForScreenXY(int16_t x, int16_t y, int16_t & index)
Gets graph index nearest to the given screen position.
intgetScale() const
Gets the scaling factor previously set using setScale().
int16_tgetUsedCapacity() const
Gets the number of point used by the graph.
virtual voidhandleClickEvent(const ClickEvent & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
floatindexToDataPointXAsFloat(int16_t index) const
Get the data point x value for the given graph point index.
intindexToDataPointXAsInt(int16_t index) const
Get the data point x value for the given graph point index.
floatindexToDataPointYAsFloat(int16_t index) const
Get the data point y value for the given graph point index.
intindexToDataPointYAsInt(int16_t index) const
Get the data point y value for the given graph point index.
int16_tindexToScreenX(int16_t index) const
Get the screen x coordinate for the given graph point index.
int16_tindexToScreenY(int16_t index) const
Get the screen y coordinate for the given graph point index.
voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
voidsetClickAction(GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > & callback)
Sets an action to be executed when the graph is clicked.
voidsetDragAction(GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > & callback)
Sets an action to be executed when the graph is dragged.
voidsetGapBeforeIndex(int16_t index)
Makes gap before the specified index.
voidsetGraphAreaMargin(int16_t top, int16_t left, int16_t right, int16_t bottom)
Sets graph position inside the widget by reserving a margin around the graph.
voidsetGraphAreaPadding(int16_t top, int16_t left, int16_t right, int16_t bottom)
Adds some padding around the graph that will not be drawn in (apart from dots, boxes etc.
voidsetGraphRange(int xMin, int xMax, float yMin, float yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
voidsetGraphRange(int xMin, int xMax, int yMin, int yMax)
Sets minimum and maximum x and y coordinate ranges for the graph.
virtual voidsetGraphRangeX(int min, int max) =0
Sets minimum and maximum x coordinates for the graph.
virtual voidsetGraphRangeY(float min, float max) =0
Sets minimum and maximum y coordinates for the graph.
virtual voidsetGraphRangeY(int min, int max) =0
Sets minimum and maximum y coordinates for the graph.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
virtual voidsetScale(int scale)
Sets a scaling factor to be multiplied on each added element.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
intfloat2scaled(float f, int scale)
Multiply a floating point value with a constant and round the result.
intint2scaled(int i, int scale)
Multiply an integer value with a constant.
floatscaled2float(int i, int scale)
Divide a floating point number with a constant.
intscaled2int(int i, int scale)
Divide an integer with a constant and round the result.

Protected Functions inherited from AbstractDataGraph#

intconvertToGraphScale(int value, int scale) const
Converts a number with one scale to a number that has the same scale as the graph.
intfloat2scaled(float f) const
Same as float2scaled(float,int) using the graph's scale.
virtual intgetGraphRangeYMaxScaled() const =0
Gets maximum y coordinate for the graph.
virtual intgetGraphRangeYMinScaled() const =0
Gets minimum y coordinate for the graph.
virtual intgetXAxisOffsetScaled() const
Get x axis offset as a scaled value.
virtual intgetXAxisScaleScaled() const
Get x axis scale as a scaled value.
virtual intindexToDataPointXScaled(int16_t index) const =0
Same as indexToDataPointXAsInt(int16_t) except the returned value is left scaled.
virtual intindexToDataPointYScaled(int16_t index) const =0
Same as indexToDataPointYAsInt(int16_t) except the returned value is left scaled.
virtual CWRUtil::Q5indexToScreenXQ5(int16_t index) const =0
Gets screen x coordinate for a specific data point added to the graph.
virtual CWRUtil::Q5indexToScreenYQ5(int16_t index) const =0
Gets screen y coordinate for a specific data point added to the graph.
intint2scaled(int i) const
Same as int2scaled(int,int) using the graph's scale.
voidinvalidateAllXAxisPoints()
Invalidate all x axis points.
voidinvalidateGraphArea()
Invalidate entire graph area (the center of the graph).
voidinvalidateGraphPointAt(int16_t index)
Invalidate point at a given index.
voidinvalidateXAxisPointAt(int16_t index)
Invalidate x axis point at the given index.
floatscaled2float(int i) const
Same as scaled2float(int,int) using the graph's scale.
intscaled2int(int i) const
Same as scaled2int(int,int) using the graph's scale.
voidsetGraphRangeScaled(int xMin, int xMax, int yMin, int yMax)
Same as setGraphRange(int,int,int,int) except the passed arguments are assumed scaled.
virtual voidsetGraphRangeYScaled(int min, int max) =0
Same as setGraphRangeY(int,int) except the passed arguments are assumed scaled.
voidupdateAreasPosition()
Updates the position of all elements in all area after a change in size of the graph area and/or label padding.
virtual CWRUtil::Q5valueToScreenXQ5(int x) const =0
Gets screen x coordinate for an absolute value.
virtual CWRUtil::Q5valueToScreenYQ5(int y) const =0
Gets screen y coordinate for an absolute value.
virtual boolxScreenRangeToIndexRange(int16_t xLo, int16_t xHi, int16_t & indexLow, int16_t & indexHigh) const =0
Gets index range for screen x coordinate range taking the current graph range into account.

Protected Attributes inherited from AbstractDataGraph#

uint8_talpha
The alpha of the entire graph.
ContainerbottomArea
The area below the graph.
int16_tbottomPadding
The graph area bottom padding.
GenericCallback< const AbstractDataGraph &, const GraphClickEvent & > *clickAction
The callback to be executed when this Graph is clicked.
intdataScale
The data scale applied to all values.
GenericCallback< const AbstractDataGraph &, const GraphDragEvent & > *dragAction
The callback to be executed when this Graph is dragged.
int16_tgapBeforeIndex
The graph is disconnected (there is a gap) before this element index.
ContainergraphArea
The graph area (the center area)
ContainerleftArea
The area to the left of the graph.
int16_tleftPadding
The graph area left padding.
int16_tmaxCapacity
Maximum number of points in the graph.
ContainerrightArea
The area to the right of the graph.
int16_trightPadding
The graph area right padding.
ContainertopArea
The area above the graph.
int16_ttopPadding
The graph area top padding.
int16_tusedCapacity
The number of used points in the graph.

Public Functions inherited from Container#

virtual voidadd(Drawable & d)
Adds a Drawable instance as child to this Container.
Container()
virtual boolcontains(const Drawable & d)
Query if a given Drawable has been added directly to this Container.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidforEachChild(GenericCallback< Drawable & > * function)
Executes the specified callback function for each child in the Container.
virtual Drawable *getFirstChild()
Obtain a pointer to the first child of this container.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Gets the last child in the list of children in this Container.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidinsert(Drawable * previous, Drawable & d)
Inserts a Drawable after a specific child node.
virtual voidremove(Drawable & d)
Removes a Drawable from the container by removing it from the linked list of children.
virtual voidremoveAll()
Removes all children in the Container by resetting their parent and sibling pointers.
virtual voidunlink()
Removes all children by unlinking the first child.

Protected Functions inherited from Container#

virtual RectgetContainedArea() const
Gets a rectangle describing the total area covered by the children of this container.
virtual voidmoveChildrenRelative(int16_t deltaX, int16_t deltaY)
Calls moveRelative on all children.

Protected Attributes inherited from Container#

Drawable *firstChild
Pointer to the first child of this container. Subsequent children can be found through firstChild's nextSibling.

Public Functions inherited from Drawable#

virtual voidchildGeometryChanged()
This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
virtual voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
RectgetAbsoluteRect() const
Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *getFirstChild()
Function for obtaining the first child of this drawable if any.
int16_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last) =0
Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *getNextSibling()
Gets the next sibling node.
Drawable *getParent() const
Returns the parent node.
const Rect &getRect() const
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & rect)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(Rect & r) const
Helper function for converting a region of this Drawable to absolute coordinates.
virtual ~Drawable()
Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable#

Drawable *nextSibling
Pointer to the next Drawable.
Drawable *parent
Pointer to this drawable's parent.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation#

DataGraphWrapAndClear#

DataGraphWrapAndClear(int16_tcapacity ,
int *values
)

Initializes a new instance of the DataGraphWrapAndOverwrite class.

Parameters:
capacityThe capacity.
valuesPointer to memory with room for capacity elements of type T.

indexToGlobalIndex#

virtual int32_t indexToGlobalIndex(int16_tindex)

Convert an index to global index.

The index is the index of any data point, The global index is a value that keeps growing whenever a new data point is added the the graph.

Parameters:
indexZero-based index of the point.
Returns:

The global index.

Reimplements: touchgfx::AbstractDataGraph::indexToGlobalIndex

Protected Functions Documentation#

addValue#

virtual int16_t addValue(intvalue)

Adds a value to the internal data array and keeps track of when graph points, graph axis and the entire graph needs to be redrawn (invalidated).

Parameters:
valueThe value to add to the array.
Returns:

The index of the newly added value.

Reimplements: touchgfx::AbstractDataGraphWithY::addValue

beforeAddValue#

virtual void beforeAddValue()

This function is called before a new value (data point) is added.

This allows for invalidation to be calculated based on the global data counter before it is increased as a result of adding the new point.

Reimplements: touchgfx::AbstractDataGraphWithY::beforeAddValue