vcsl_axis Class Reference

Axis descriptor: a dimension, a unit, a label. More...

#include <vcsl_axis.h>

Inheritance diagram for vcsl_axis:

Public Member Functions
	vcsl_axis ()
	Default constructor. Axis with length in meters and an empty label. More...
	vcsl_axis (vcsl_dimension_sptr const &new_dimension)
	Constructor from dimension. Unit is the standard one. Label is empty. More...
	vcsl_axis (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit)
	Constructor from dimension and unit. Label is empty. More...
	vcsl_axis (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit, std::string new_label)
	Constructor from dimension, unit and label. More...
	vcsl_axis (const vcsl_axis &a)
	~vcsl_axis () override=default
vcsl_dimension_sptr	dimension () const
	Return the dimension. More...
vcsl_unit_sptr	unit () const
	Return the unit of the dimension. More...
std::string	label () const
	Return the label of the axis. More...
void	set_dimension (vcsl_dimension_sptr const &new_dimension)
	Set the dimension. The unit is set with the standard unit. More...
void	set_dimension_and_unit (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit)
	Set the dimension and the unit. More...
void	set_unit (vcsl_unit_sptr const &new_unit)
	Set the unit of the dimension. More...
void	set_label (std::string const &new_label)
	Set the label. More...
void	ref ()
void	unref ()
long	get_references () const
bool	is_referenced () const

Protected Attributes
vcsl_dimension_sptr	dimension_
	Dimension. More...
vcsl_unit_sptr	unit_
	Unit of the dimension. More...
std::string	label_
	Label of the axis. More...

Detailed Description

Axis descriptor: a dimension, a unit, a label.

Definition at line 25 of file vcsl_axis.h.

Constructor & Destructor Documentation

vcsl_axis() [1/5]

vcsl_axis::vcsl_axis

(

)

Default constructor. Axis with length in meters and an empty label.

Definition at line 16 of file vcsl_axis.cxx.

vcsl_axis() [2/5]

vcsl_axis::vcsl_axis ( vcsl_dimension_sptr const &  new_dimension )

explicit

Constructor from dimension. Unit is the standard one. Label is empty.

Definition at line 25 of file vcsl_axis.cxx.

vcsl_axis() [3/5]

vcsl_axis::vcsl_axis	(	vcsl_dimension_sptr const &	new_dimension,
		vcsl_unit_sptr const &	new_unit
	)

Constructor from dimension and unit. Label is empty.

REQUIRE: new_dimension.compatible_unit(new_unit)

Definition at line 35 of file vcsl_axis.cxx.

vcsl_axis() [4/5]

vcsl_axis::vcsl_axis ( vcsl_dimension_sptr const &  new_dimension, vcsl_unit_sptr const &  new_unit, std::string  new_label  )

inline

Constructor from dimension, unit and label.

Definition at line 45 of file vcsl_axis.h.

vcsl_axis() [5/5]

vcsl_axis::vcsl_axis ( const vcsl_axis &  a )

inline

Definition at line 51 of file vcsl_axis.h.

~vcsl_axis()

vcsl_axis::~vcsl_axis ( )

overridedefault

Member Function Documentation

dimension()

vcsl_dimension_sptr vcsl_axis::dimension ( ) const

inline

Return the dimension.

Definition at line 62 of file vcsl_axis.h.

label()

std::string vcsl_axis::label ( ) const

inline

Return the label of the axis.

Definition at line 68 of file vcsl_axis.h.

set_dimension()

void vcsl_axis::set_dimension

(

vcsl_dimension_sptr const &

new_dimension

)

Set the dimension. The unit is set with the standard unit.

Definition at line 48 of file vcsl_axis.cxx.

set_dimension_and_unit()

void vcsl_axis::set_dimension_and_unit	(	vcsl_dimension_sptr const &	new_dimension,
		vcsl_unit_sptr const &	new_unit
	)

Set the dimension and the unit.

REQUIRE: new_dimension.compatible_unit(new_unit)

Definition at line 58 of file vcsl_axis.cxx.

set_label()

void vcsl_axis::set_label ( std::string const &  new_label )

inline

Set the label.

Definition at line 87 of file vcsl_axis.h.

set_unit()

void vcsl_axis::set_unit

(

vcsl_unit_sptr const &

new_unit

)

Set the unit of the dimension.

REQUIRE dimension()->compatible_unit(new_unit)

Definition at line 72 of file vcsl_axis.cxx.

unit()

vcsl_unit_sptr vcsl_axis::unit ( ) const

inline

Return the unit of the dimension.

Definition at line 65 of file vcsl_axis.h.

Member Data Documentation

dimension_

vcsl_dimension_sptr vcsl_axis::dimension_

protected

Dimension.

Definition at line 95 of file vcsl_axis.h.

label_

std::string vcsl_axis::label_

protected

Label of the axis.

Definition at line 101 of file vcsl_axis.h.

unit_

vcsl_unit_sptr vcsl_axis::unit_

protected

Unit of the dimension.

Definition at line 98 of file vcsl_axis.h.

---

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

• core/vcsl/vcsl_axis.h
• core/vcsl/vcsl_axis.cxx