OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::Plot1DDataBaseCfg Class Reference

#include "Plot1DDataBaseCfg.h"

Inheritance diagram for ot::Plot1DDataBaseCfg:
ot::Plot1DCfg ot::Serializable

Public Member Functions

 Plot1DDataBaseCfg ()
 
 Plot1DDataBaseCfg (const Plot1DDataBaseCfg &_other)
 
 Plot1DDataBaseCfg (const Plot1DCfg &_other)
 
virtual ~Plot1DDataBaseCfg ()
 
Plot1DDataBaseCfgoperator= (const Plot1DDataBaseCfg &_other)
 
Plot1DDataBaseCfgoperator= (const Plot1DCfg &_other)
 
virtual void addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const override
 Add the object contents to the provided JSON object.
 
virtual void setFromJsonObject (const ot::ConstJsonObject &_object) override
 Set the object contents from the provided JSON object.
 
void addCurve (const Plot1DCurveInfoCfg &_curve)
 
void setCurves (const std::list< Plot1DCurveInfoCfg > &_curves)
 
const std::list< Plot1DCurveInfoCfg > & getCurves (void) const
 
bool updateCurveVersion (ot::UID _curveEntityUID, ot::UID _newCurveEntityVersion)
 Updates the curve version. Returns true if the version has been changed.
 
- Public Member Functions inherited from ot::Plot1DCfg
 Plot1DCfg ()
 
 Plot1DCfg (const Plot1DCfg &_other)
 
virtual ~Plot1DCfg ()
 
Plot1DCfgoperator= (const Plot1DCfg &_other)
 
bool operator== (const Plot1DCfg &_other) const
 
bool operator!= (const Plot1DCfg &_other) const
 
void setUid (UID _uid)
 
UID getUid (void) const
 
void setName (const std::string &_name)
 
const std::string & getName (void) const
 
void setTitle (const std::string &_title)
 
const std::string & getTitle (void) const
 
void setProjectName (const std::string &_projectName)
 
const std::string & getProjectName (void) const
 
void setPlotType (PlotType _type)
 
PlotType getPlotType (void) const
 
void setAxisQuantity (AxisQuantity _quantity)
 
AxisQuantity getAxisQuantity (void) const
 
void setGridVisible (bool _visible)
 
bool getGridVisible (void) const
 
void setGridColor (const Color &_color)
 
const ColorgetGridColor (void) const
 
void setGridLineWidth (double _width)
 
double getGridLineWidth (void) const
 
void setHidden (bool _isHidden)
 
bool getHidden (void) const
 
void setLegendVisible (bool _isVisible)
 
bool getLegendVisible (void) const
 
void setOldTreeIcons (const NavigationTreeItemIcon &_icons)
 
const NavigationTreeItemIcongetOldTreeIcons (void) const
 
void setXAxis (const Plot1DAxisCfg &_xAxis)
 
const Plot1DAxisCfggetXAxis (void) const
 
void setXAxisMin (double _min)
 
double getXAxisMin (void) const
 
void setXAxisMax (double _max)
 
double getXAxisMax (void) const
 
void setXAxisIsLogScale (bool _logScaleEnabled)
 
bool getXAxisIsLogScale (void) const
 
void setXAxisIsAutoScale (bool _autoScaleEnabled)
 
bool getXAxisIsAutoScale (void) const
 
void setYAxis (const Plot1DAxisCfg &_yAxis)
 
const Plot1DAxisCfggetYAxis (void) const
 
void setYAxisMin (double _min)
 
double getYAxisMin (void) const
 
void setYAxisMax (double _max)
 
double getYAxisMax (void) const
 
void setYAxisIsLogScale (bool _logScaleEnabled)
 
bool getYAxisIsLogScale (void) const
 
void setYAxisIsAutoScale (bool _autoScaleEnabled)
 
bool getYAxisIsAutoScale (void) const
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()
 
virtual ~Serializable ()
 

Additional Inherited Members

- Public Types inherited from ot::Plot1DCfg
enum  PlotType { Cartesian , Polar }
 
enum  AxisQuantity {
  Magnitude , Phase , Real , Imaginary ,
  Complex
}
 
- Static Public Member Functions inherited from ot::Plot1DCfg
static std::string plotTypeToString (PlotType _type)
 
static PlotType stringToPlotType (const std::string &_type)
 
static std::string axisQuantityToString (AxisQuantity _quantity)
 
static AxisQuantity stringToAxisQuantity (const std::string &_quantity)
 

Constructor & Destructor Documentation

◆ Plot1DDataBaseCfg() [1/3]

ot::Plot1DDataBaseCfg::Plot1DDataBaseCfg ( )

◆ Plot1DDataBaseCfg() [2/3]

ot::Plot1DDataBaseCfg::Plot1DDataBaseCfg ( const Plot1DDataBaseCfg & _other)

◆ Plot1DDataBaseCfg() [3/3]

ot::Plot1DDataBaseCfg::Plot1DDataBaseCfg ( const Plot1DCfg & _other)

◆ ~Plot1DDataBaseCfg()

ot::Plot1DDataBaseCfg::~Plot1DDataBaseCfg ( )
virtual

Member Function Documentation

◆ addCurve()

void ot::Plot1DDataBaseCfg::addCurve ( const Plot1DCurveInfoCfg & _curve)

◆ addToJsonObject()

void ot::Plot1DDataBaseCfg::addToJsonObject ( ot::JsonValue & _object,
ot::JsonAllocator & _allocator ) const
overridevirtual

Add the object contents to the provided JSON object.

Parameters
_objectJson object reference to write the data to.
_allocatorAllocator.

Reimplemented from ot::Plot1DCfg.

◆ getCurves()

const std::list< Plot1DCurveInfoCfg > & ot::Plot1DDataBaseCfg::getCurves ( void ) const
inline

◆ operator=() [1/2]

ot::Plot1DDataBaseCfg & ot::Plot1DDataBaseCfg::operator= ( const Plot1DCfg & _other)

◆ operator=() [2/2]

ot::Plot1DDataBaseCfg & ot::Plot1DDataBaseCfg::operator= ( const Plot1DDataBaseCfg & _other)

◆ setCurves()

void ot::Plot1DDataBaseCfg::setCurves ( const std::list< Plot1DCurveInfoCfg > & _curves)
inline

◆ setFromJsonObject()

void ot::Plot1DDataBaseCfg::setFromJsonObject ( const ot::ConstJsonObject & _object)
overridevirtual

Set the object contents from the provided JSON object.

Parameters
_objectThe JSON object containing the information.
Exceptions
Maythrow an exception if the provided object is not valid (members missing or invalid types).

Reimplemented from ot::Plot1DCfg.

◆ updateCurveVersion()

bool ot::Plot1DDataBaseCfg::updateCurveVersion ( ot::UID _curveEntityUID,
ot::UID _newCurveEntityVersion )

Updates the curve version. Returns true if the version has been changed.


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