shark::Chart::Axis Struct Reference

Models an axis and its attributes like its title and its scale. More...

#include <shark/Core/Chart.h>

Collaboration diagram for shark::Chart::Axis:

Public Types
enum	Scale { LINEAR_SCALE, LOG_10_SCALE }
	Models the scale of the axis. More...

Public Member Functions
	Axis (bool isEnabled=false)
	C'tor. More...
boost::property_tree::ptree &	properties ()
	Access the properties of the axis. More...
const boost::property_tree::ptree &	properties () const
	Access the properties of the axis. More...
template<typename Archive >
void	serialize (Archive &a, const unsigned int version)
	(De-)Serializes the axis, its attributes and properties. More...

Public Attributes
bool	m_isEnabled
	Indicates whether the axis is enabled or not. More...
Scale	m_scale
	The scaling of the axis. More...
std::string	m_title
	The title of the axis. More...
boost::property_tree::ptree	m_properties
	The properties of the axis. More...

Detailed Description

Models an axis and its attributes like its title and its scale.

Definition at line 118 of file Chart.h.

Member Enumeration Documentation

enum shark::Chart::Axis::Scale

Models the scale of the axis.

Enumerator
LINEAR_SCALE	Default setting.
LOG_10_SCALE

Definition at line 123 of file Chart.h.

Constructor & Destructor Documentation

shark::Chart::Axis::Axis ( bool  isEnabled = false )

inline

C'tor.

Parameters

[in]

isEnabled

Flag that indicate whether the axis shall be enabled or not.

Definition at line 133 of file Chart.h.

Member Function Documentation

boost::property_tree::ptree& shark::Chart::Axis::properties ( )

inline

Access the properties of the axis.

In addition to the attributes that are explicitly modelled arbitrary key/value pairs can be associated with the axis. These key/value-pairs might be used by renderers to further customize the output.

Returns

A mutable reference to the properties, allows for l-value semantics.

Definition at line 146 of file Chart.h.

References m_properties.

const boost::property_tree::ptree& shark::Chart::Axis::properties ( ) const

inline

Access the properties of the axis.

In addition to the attributes that are explicitly modelled arbitrary key/value pairs can be associated with the axis. These key/value-pairs might be used by renderers to further customize the output.

Returns

An immutable reference to the properties.

Definition at line 160 of file Chart.h.

References m_properties.

template<typename Archive >

void shark::Chart::Axis::serialize ( Archive &  a, const unsigned int  version  )

inline

(De-)Serializes the axis, its attributes and properties.

Template Parameters

Archive

The type of the archive.

Parameters

[in,out]	a	The archive to read from/write to.
[in]	version	Currently unused.

Definition at line 172 of file Chart.h.

References m_properties, m_scale, and m_title.

Member Data Documentation

bool shark::Chart::Axis::m_isEnabled

Indicates whether the axis is enabled or not.

Definition at line 179 of file Chart.h.

boost::property_tree::ptree shark::Chart::Axis::m_properties

The properties of the axis.

Definition at line 184 of file Chart.h.

Referenced by properties(), and serialize().

Scale shark::Chart::Axis::m_scale

The scaling of the axis.

Definition at line 181 of file Chart.h.

Referenced by serialize().

std::string shark::Chart::Axis::m_title

The title of the axis.

Definition at line 182 of file Chart.h.

Referenced by shark::HighchartRenderer< Stream >::render(), and serialize().

---

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

• include/shark/Core/Chart.h