ot::Plot1DCfg Class Reference

#include "Plot1DCfg.h"

Inheritance diagram for ot::Plot1DCfg:

Public Types
enum	PlotType { Cartesian , Polar }
enum	AxisQuantity {   Magnitude , Phase , Real , Imaginary ,   Complex }

Public Member Functions
	Plot1DCfg ()
	Plot1DCfg (const Plot1DCfg &_other)
virtual	~Plot1DCfg ()
Plot1DCfg &	operator= (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.
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 Color &	getGridColor (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 NavigationTreeItemIcon &	getOldTreeIcons (void) const
void	setXAxis (const Plot1DAxisCfg &_xAxis)
const Plot1DAxisCfg &	getXAxis (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 Plot1DAxisCfg &	getYAxis (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 ()

Static Public Member Functions
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)

Member Enumeration Documentation

AxisQuantity

enum ot::Plot1DCfg::AxisQuantity

Enumerator
Magnitude
Phase
Real
Imaginary
Complex

PlotType

enum ot::Plot1DCfg::PlotType

Enumerator
Cartesian
Polar

Constructor & Destructor Documentation

Plot1DCfg() [1/2]

ot::Plot1DCfg::Plot1DCfg

(

)

Plot1DCfg() [2/2]

ot::Plot1DCfg::Plot1DCfg

(

const Plot1DCfg &

_other

)

~Plot1DCfg()

ot::Plot1DCfg::~Plot1DCfg ( )

virtual

Member Function Documentation

addToJsonObject()

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

overridevirtual

Add the object contents to the provided JSON object.

Parameters

_object	Json object reference to write the data to.
_allocator	Allocator.

Implements ot::Serializable.

Reimplemented in ot::Plot1DDataBaseCfg.

axisQuantityToString()

std::string ot::Plot1DCfg::axisQuantityToString ( AxisQuantity _quantity )

static

getAxisQuantity()

AxisQuantity ot::Plot1DCfg::getAxisQuantity ( void ) const

inline

getGridColor()

const Color & ot::Plot1DCfg::getGridColor ( void ) const

inline

getGridLineWidth()

double ot::Plot1DCfg::getGridLineWidth ( void ) const

inline

getGridVisible()

bool ot::Plot1DCfg::getGridVisible ( void ) const

inline

getHidden()

bool ot::Plot1DCfg::getHidden ( void ) const

inline

getLegendVisible()

bool ot::Plot1DCfg::getLegendVisible ( void ) const

inline

getName()

const std::string & ot::Plot1DCfg::getName ( void ) const

inline

getOldTreeIcons()

const NavigationTreeItemIcon & ot::Plot1DCfg::getOldTreeIcons ( void ) const

inline

getPlotType()

PlotType ot::Plot1DCfg::getPlotType ( void ) const

inline

getProjectName()

const std::string & ot::Plot1DCfg::getProjectName ( void ) const

inline

getTitle()

const std::string & ot::Plot1DCfg::getTitle ( void ) const

inline

getUid()

UID ot::Plot1DCfg::getUid ( void ) const

inline

getXAxis()

const Plot1DAxisCfg & ot::Plot1DCfg::getXAxis ( void ) const

inline

getXAxisIsAutoScale()

bool ot::Plot1DCfg::getXAxisIsAutoScale ( void ) const

inline

getXAxisIsLogScale()

bool ot::Plot1DCfg::getXAxisIsLogScale ( void ) const

inline

getXAxisMax()

double ot::Plot1DCfg::getXAxisMax ( void ) const

inline

getXAxisMin()

double ot::Plot1DCfg::getXAxisMin ( void ) const

inline

getYAxis()

const Plot1DAxisCfg & ot::Plot1DCfg::getYAxis ( void ) const

inline

getYAxisIsAutoScale()

bool ot::Plot1DCfg::getYAxisIsAutoScale ( void ) const

inline

getYAxisIsLogScale()

bool ot::Plot1DCfg::getYAxisIsLogScale ( void ) const

inline

getYAxisMax()

double ot::Plot1DCfg::getYAxisMax ( void ) const

inline

getYAxisMin()

double ot::Plot1DCfg::getYAxisMin ( void ) const

inline

operator!=()

bool ot::Plot1DCfg::operator!=

(

const Plot1DCfg &

_other

)

const

operator=()

ot::Plot1DCfg & ot::Plot1DCfg::operator=

(

const Plot1DCfg &

_other

)

operator==()

bool ot::Plot1DCfg::operator==

(

const Plot1DCfg &

_other

)

const

plotTypeToString()

std::string ot::Plot1DCfg::plotTypeToString ( PlotType _type )

static

setAxisQuantity()

void ot::Plot1DCfg::setAxisQuantity ( AxisQuantity _quantity )

inline

setFromJsonObject()

void ot::Plot1DCfg::setFromJsonObject ( const ot::ConstJsonObject & _object )

overridevirtual

Set the object contents from the provided JSON object.

Parameters

_object

The JSON object containing the information.

Exceptions

May	throw an exception if the provided object is not valid (members missing or invalid types).

Implements ot::Serializable.

Reimplemented in ot::Plot1DDataBaseCfg.

setGridColor()

void ot::Plot1DCfg::setGridColor ( const Color & _color )

inline

setGridLineWidth()

void ot::Plot1DCfg::setGridLineWidth ( double _width )

inline

setGridVisible()

void ot::Plot1DCfg::setGridVisible ( bool _visible )

inline

setHidden()

void ot::Plot1DCfg::setHidden ( bool _isHidden )

inline

setLegendVisible()

void ot::Plot1DCfg::setLegendVisible ( bool _isVisible )

inline

setName()

void ot::Plot1DCfg::setName ( const std::string & _name )

inline

setOldTreeIcons()

void ot::Plot1DCfg::setOldTreeIcons ( const NavigationTreeItemIcon & _icons )

inline

setPlotType()

void ot::Plot1DCfg::setPlotType ( PlotType _type )

inline

setProjectName()

void ot::Plot1DCfg::setProjectName ( const std::string & _projectName )

inline

setTitle()

void ot::Plot1DCfg::setTitle ( const std::string & _title )

inline

setUid()

void ot::Plot1DCfg::setUid ( UID _uid )

inline

setXAxis()

void ot::Plot1DCfg::setXAxis ( const Plot1DAxisCfg & _xAxis )

inline

setXAxisIsAutoScale()

void ot::Plot1DCfg::setXAxisIsAutoScale ( bool _autoScaleEnabled )

inline

setXAxisIsLogScale()

void ot::Plot1DCfg::setXAxisIsLogScale ( bool _logScaleEnabled )

inline

setXAxisMax()

void ot::Plot1DCfg::setXAxisMax ( double _max )

inline

setXAxisMin()

void ot::Plot1DCfg::setXAxisMin ( double _min )

inline

setYAxis()

void ot::Plot1DCfg::setYAxis ( const Plot1DAxisCfg & _yAxis )

inline

setYAxisIsAutoScale()

void ot::Plot1DCfg::setYAxisIsAutoScale ( bool _autoScaleEnabled )

inline

setYAxisIsLogScale()

void ot::Plot1DCfg::setYAxisIsLogScale ( bool _logScaleEnabled )

inline

setYAxisMax()

void ot::Plot1DCfg::setYAxisMax ( double _max )

inline

setYAxisMin()

void ot::Plot1DCfg::setYAxisMin ( double _min )

inline

stringToAxisQuantity()

ot::Plot1DCfg::AxisQuantity ot::Plot1DCfg::stringToAxisQuantity ( const std::string & _quantity )

static

stringToPlotType()

ot::Plot1DCfg::PlotType ot::Plot1DCfg::stringToPlotType ( const std::string & _type )

static

---

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

• Libraries/OTGui/include/OTGui/Plot1DCfg.h
• Libraries/OTGui/src/Plot1DCfg.cpp