0.4.1
Loading...
Searching...
No Matches
NAV::Plot::PinData Struct Reference

Information needed to plot the data on a certain pin. More...

Data Structures

struct  PlotData
 Stores the actual data coming from a pin. More...
 

Public Types

enum class  PinType : uint8_t {
  Flow ,
  Bool ,
  Int ,
  Float ,
  Matrix
}
 Possible Pin types. More...
 

Public Member Functions

void addPlotDataItem (size_t dataIndex, const std::string &displayName)
 Adds a plotData Element to the list.
 
PinDataoperator= (const PinData &rhs)
 Copy assignment operator.
 
PinDataoperator= (PinData &&rhs) noexcept
 Move assignment operator.
 
 PinData ()=default
 Constructor.
 
 PinData (const PinData &other)
 Copy constructor.
 
 PinData (PinData &&other) noexcept
 Move constructor.
 
 ~PinData ()=default
 Destructor.
 

Data Fields

std::string dataIdentifier
 Data Identifier of the connected pin.
 
int dynamicDataStartIndex
 Dynamic data start index.
 
std::vector< std::tuple< double, InsTime, std::string, int32_t > > events
 Events with relative time, absolute time, tooltip text and data Index (-1 means all)
 
std::mutex mutex
 Mutex to lock the buffer so that the GUI thread and the calculation threads don't cause a data race.
 
PinType pinType
 Pin Type.
 
std::vector< PlotDataplotData
 List with all the data.
 
ScrollingBuffer< std::shared_ptr< const NodeData > > rawNodeData
 List with the raw data received.
 
int size
 Size of all buffers of the plotData elements.
 
int stride
 Amount of points to skip for plotting.
 

Detailed Description

Information needed to plot the data on a certain pin.

Definition at line 99 of file Plot.hpp.

Member Enumeration Documentation

◆ PinType

enum class NAV::Plot::PinData::PinType : uint8_t
strong

Possible Pin types.

Enumerator
Flow 

NodeData Trigger.

Bool 

Boolean.

Int 

Integer Number.

Float 

Floating Point Number.

Matrix 

Matrix Object.

Definition at line 126 of file Plot.hpp.

Constructor & Destructor Documentation

◆ PinData() [1/3]

NAV::Plot::PinData::PinData ( )
default

Constructor.

◆ ~PinData()

NAV::Plot::PinData::~PinData ( )
default

Destructor.

◆ PinData() [2/3]

NAV::Plot::PinData::PinData ( const PinData & other)

Copy constructor.

Parameters
[in]otherThe other element to copy

Definition at line 206 of file Plot.cpp.

◆ PinData() [3/3]

NAV::Plot::PinData::PinData ( PinData && other)
noexcept

Move constructor.

Parameters
[in]otherThe other element to move

Definition at line 214 of file Plot.cpp.

Member Function Documentation

◆ addPlotDataItem()

void NAV::Plot::PinData::addPlotDataItem ( size_t dataIndex,
const std::string & displayName )

Adds a plotData Element to the list.

Parameters
[in]dataIndexIndex where to add the data to
[in]displayNameDisplay name of the contained data

Definition at line 252 of file Plot.cpp.

◆ operator=() [1/2]

NAV::Plot::PinData & NAV::Plot::PinData::operator= ( const PinData & rhs)

Copy assignment operator.

Parameters
[in]rhsThe other element to copy

Definition at line 222 of file Plot.cpp.

◆ operator=() [2/2]

NAV::Plot::PinData & NAV::Plot::PinData::operator= ( PinData && rhs)
noexcept

Move assignment operator.

Parameters
[in]rhsThe other element to move

Definition at line 237 of file Plot.cpp.

Field Documentation

◆ dataIdentifier

std::string NAV::Plot::PinData::dataIdentifier

Data Identifier of the connected pin.

Definition at line 162 of file Plot.hpp.

◆ dynamicDataStartIndex

int NAV::Plot::PinData::dynamicDataStartIndex

Dynamic data start index.

Definition at line 174 of file Plot.hpp.

◆ events

std::vector<std::tuple<double, InsTime, std::string, int32_t> > NAV::Plot::PinData::events

Events with relative time, absolute time, tooltip text and data Index (-1 means all)

Definition at line 176 of file Plot.hpp.

◆ mutex

std::mutex NAV::Plot::PinData::mutex

Mutex to lock the buffer so that the GUI thread and the calculation threads don't cause a data race.

Definition at line 172 of file Plot.hpp.

◆ pinType

PinType NAV::Plot::PinData::pinType

Pin Type.

Definition at line 168 of file Plot.hpp.

◆ plotData

std::vector<PlotData> NAV::Plot::PinData::plotData

List with all the data.

Definition at line 164 of file Plot.hpp.

◆ rawNodeData

ScrollingBuffer<std::shared_ptr<const NodeData> > NAV::Plot::PinData::rawNodeData

List with the raw data received.

Definition at line 166 of file Plot.hpp.

◆ size

int NAV::Plot::PinData::size

Size of all buffers of the plotData elements.

Definition at line 160 of file Plot.hpp.

◆ stride

int NAV::Plot::PinData::stride

Amount of points to skip for plotting.

Definition at line 170 of file Plot.hpp.


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