PlotData Class Reference
Plot Data container to hold value and registered charts Can be a Field or a PlotComponent Used by PlottingInterface and Gazebo Plotting. More...
#include <PlottingInterface.hh>
Public Member Functions | |
| PlotData () | |
| Constructor. | |
| ~PlotData () | |
| Destructor. | |
| void | AddChart (int _chart) |
| Register a chart that plot that field. | |
| int | ChartCount () const |
| Number of registered charts. | |
| std::set< int > & | Charts () |
| Get all registered charts to that field. | |
| void | RemoveChart (int _chart) |
| UnRegister a chart from plotting that field. | |
| void | SetTime (const double _time) |
| Set the field arrival time. | |
| void | SetValue (const double _value) |
| Set the field Value. | |
| double | Time () const |
| Get the arrival time. | |
| double | Value () const |
| Get the field value. | |
Detailed Description
Plot Data container to hold value and registered charts Can be a Field or a PlotComponent Used by PlottingInterface and Gazebo Plotting.
Constructor & Destructor Documentation
◆ PlotData()
| PlotData | ( | ) |
Constructor.
◆ ~PlotData()
| ~PlotData | ( | ) |
Destructor.
Member Function Documentation
◆ AddChart()
| void AddChart | ( | int | _chart | ) |
Register a chart that plot that field.
- Parameters
-
[in] _chart chart ID to be registered
◆ ChartCount()
| int ChartCount | ( | ) | const |
Number of registered charts.
- Returns
- Charts count
◆ Charts()
| std::set< int > & Charts | ( | ) |
Get all registered charts to that field.
- Returns
- Set of registered charts
◆ RemoveChart()
| void RemoveChart | ( | int | _chart | ) |
UnRegister a chart from plotting that field.
◆ SetTime()
| void SetTime | ( | const double | _time | ) |
Set the field arrival time.
- Parameters
-
[in] _time arrival time to set it
◆ SetValue()
| void SetValue | ( | const double | _value | ) |
Set the field Value.
- Parameters
-
[in] _value the set value
◆ Time()
| double Time | ( | ) | const |
Get the arrival time.
- Returns
- arrival time
◆ Value()
| double Value | ( | ) | const |
Get the field value.
- Returns
- value of the field
The documentation for this class was generated from the following file: