NAV::Plot::PlotInfo::PlotItem Struct Reference

Info needed to draw a data set. More...

Public Member Functions
constexpr bool	operator== (const PlotItem &rhs) const
	Equal comparison operator (needed to search the vector with std::find)
	PlotItem ()=default
	Default constructor (needed to make serialization with json working)
	PlotItem (size_t pinIndex, size_t dataIndex, std::string displayName)
	Constructor.
	PlotItem (size_t pinIndex, size_t dataIndex, std::string displayName, ImAxis axis)
	Constructor.

Data Fields
ImAxis	axis
	Axis to plot the data on (Y1, Y2, Y3)
ScrollingBuffer< ImU32 >	colormapMaskColors
	Buffer for the colormap mask.
size_t	colormapMaskVersion
	Colormap version (to track updates of the colormap)
size_t	dataIndex
	Index of the data on the pin.
std::string	displayName
	Display name of the data (not changing and unique)
std::array< ScrollingBuffer< double >, 2 >	errorBoundsData
	Error bounds lower and upper data.
ScrollingBuffer< double >	eventMarker
	Buffer for event markers.
std::vector< std::tuple< double, double, PlotEventTooltip > >	eventTooltips
	List of tooltips (x,y, tooltip)
ScrollingBuffer< ImU32 >	markerColormapMaskColors
	Buffer for the colormap mask.
size_t	markerColormapMaskVersion
	Colormap version (to track updates of the colormap)
size_t	pinIndex
	Index of the pin where the data came in.
PlotItemStyle	style

Detailed Description

Info needed to draw a data set.

Definition at line 184 of file Plot.hpp.

Constructor & Destructor Documentation

PlotItem() [1/3]

NAV::Plot::PlotInfo::PlotItem::PlotItem ( )

default

Default constructor (needed to make serialization with json working)

PlotItem() [2/3]

NAV::Plot::PlotInfo::PlotItem::PlotItem ( size_t pinIndex, size_t dataIndex, std::string displayName )

inline

Constructor.

Parameters

[in]	pinIndex	Index of the pin where the data came in
[in]	dataIndex	Index of the data on the pin
[in]	displayName	Display name of the data

Definition at line 193 of file Plot.hpp.

PlotItem() [3/3]

NAV::Plot::PlotInfo::PlotItem::PlotItem ( size_t pinIndex, size_t dataIndex, std::string displayName, ImAxis axis )

inline

Constructor.

Parameters

[in]	pinIndex	Index of the pin where the data came in
[in]	dataIndex	Index of the data on the pin
[in]	displayName	Display name of the data
[in]	axis	Axis to plot the data on (Y1, Y2, Y3)

Definition at line 205 of file Plot.hpp.

Member Function Documentation

operator==()

bool NAV::Plot::PlotInfo::PlotItem::operator== ( const PlotItem & rhs ) const

inlineconstexpr

Equal comparison operator (needed to search the vector with std::find)

Parameters

[in]

rhs

Right-hand-side of the operator

Returns

True if the pin and data indices match

Definition at line 214 of file Plot.hpp.

Field Documentation

axis

ImAxis NAV::Plot::PlotInfo::PlotItem::axis

Axis to plot the data on (Y1, Y2, Y3)

Definition at line 222 of file Plot.hpp.

colormapMaskColors

ScrollingBuffer<ImU32> NAV::Plot::PlotInfo::PlotItem::colormapMaskColors

Buffer for the colormap mask.

Definition at line 225 of file Plot.hpp.

colormapMaskVersion

size_t NAV::Plot::PlotInfo::PlotItem::colormapMaskVersion

Colormap version (to track updates of the colormap)

Definition at line 227 of file Plot.hpp.

dataIndex

size_t NAV::Plot::PlotInfo::PlotItem::dataIndex

Index of the data on the pin.

Definition at line 220 of file Plot.hpp.

displayName

std::string NAV::Plot::PlotInfo::PlotItem::displayName

Display name of the data (not changing and unique)

Definition at line 221 of file Plot.hpp.

errorBoundsData

std::array<ScrollingBuffer<double>, 2> NAV::Plot::PlotInfo::PlotItem::errorBoundsData

Error bounds lower and upper data.

Definition at line 237 of file Plot.hpp.

eventMarker

ScrollingBuffer<double> NAV::Plot::PlotInfo::PlotItem::eventMarker

Buffer for event markers.

Definition at line 234 of file Plot.hpp.

eventTooltips

std::vector<std::tuple<double, double, PlotEventTooltip> > NAV::Plot::PlotInfo::PlotItem::eventTooltips

List of tooltips (x,y, tooltip)

Definition at line 240 of file Plot.hpp.

markerColormapMaskColors

ScrollingBuffer<ImU32> NAV::Plot::PlotInfo::PlotItem::markerColormapMaskColors

Buffer for the colormap mask.

Definition at line 229 of file Plot.hpp.

markerColormapMaskVersion

size_t NAV::Plot::PlotInfo::PlotItem::markerColormapMaskVersion

Colormap version (to track updates of the colormap)

Definition at line 231 of file Plot.hpp.

pinIndex

size_t NAV::Plot::PlotInfo::PlotItem::pinIndex

Index of the pin where the data came in.

Definition at line 219 of file Plot.hpp.

style

PlotItemStyle NAV::Plot::PlotInfo::PlotItem::style

Defines how the data should be plotted

Definition at line 223 of file Plot.hpp.

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/Nodes/Plotting/Plot.hpp