vcsl_axis Class Reference

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

#include <vcsl_axis.h>

Inheritance diagram for vcsl_axis:

List of all members.

Public Member Functions
	vcsl_axis ()
	Default constructor. Axis with length in meters and an empty label.
	vcsl_axis (vcsl_dimension_sptr const &new_dimension)
	Constructor from dimension. Unit is the standard one. Label is empty.
	vcsl_axis (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit)
	Constructor from dimension and unit. Label is empty.
	vcsl_axis (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit, vcl_string const &new_label)
	Constructor from dimension, unit and label.
	vcsl_axis (const vcsl_axis &a)
	~vcsl_axis ()
vcsl_dimension_sptr	dimension () const
	Return the dimension.
vcsl_unit_sptr	unit () const
	Return the unit of the dimension.
vcl_string	label () const
	Return the label of the axis.
void	set_dimension (vcsl_dimension_sptr const &new_dimension)
	Set the dimension. The unit is set with the standard unit.
void	set_dimension_and_unit (vcsl_dimension_sptr const &new_dimension, vcsl_unit_sptr const &new_unit)
	Set the dimension and the unit.
void	set_unit (vcsl_unit_sptr const &new_unit)
	Set the unit of the dimension.
void	set_label (vcl_string const &new_label)
	Set the label.
void	ref ()
void	unref ()
int	get_references () const
bool	is_referenced () const
Protected Attributes
vcsl_dimension_sptr	dimension_
	Dimension.
vcsl_unit_sptr	unit_
	Unit of the dimension.
vcl_string	label_
	Label of the axis.

---

Detailed Description

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

Definition at line 21 of file vcsl_axis.h.

---

Constructor & Destructor Documentation

vcsl_axis::vcsl_axis

(

)

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

Definition at line 13 of file vcsl_axis.cxx.

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 22 of file vcsl_axis.cxx.

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 32 of file vcsl_axis.cxx.

vcsl_axis::vcsl_axis	(	vcsl_dimension_sptr const &	new_dimension,
		vcsl_unit_sptr const &	new_unit,
		vcl_string const &	new_label
	)		[inline]

Constructor from dimension, unit and label.

Definition at line 41 of file vcsl_axis.h.

vcsl_axis::vcsl_axis

(

const vcsl_axis &

a

)

[inline]

Definition at line 47 of file vcsl_axis.h.

vcsl_axis::~vcsl_axis

(

)

[inline]

Definition at line 51 of file vcsl_axis.h.

---

Member Function Documentation

vcsl_dimension_sptr vcsl_axis::dimension

(

)

const [inline]

Return the dimension.

Definition at line 58 of file vcsl_axis.h.

vcl_string vcsl_axis::label

(

)

const [inline]

Return the label of the axis.

Definition at line 64 of file vcsl_axis.h.

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 45 of file vcsl_axis.cxx.

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 55 of file vcsl_axis.cxx.

void vcsl_axis::set_label

(

vcl_string const &

new_label

)

[inline]

Set the label.

Definition at line 83 of file vcsl_axis.h.

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 69 of file vcsl_axis.cxx.

vcsl_unit_sptr vcsl_axis::unit

(

)

const [inline]

Return the unit of the dimension.

Definition at line 61 of file vcsl_axis.h.

---

Member Data Documentation

vcsl_dimension_sptr vcsl_axis::dimension_ [protected]

Dimension.

Definition at line 91 of file vcsl_axis.h.

vcl_string vcsl_axis::label_ [protected]

Label of the axis.

Definition at line 97 of file vcsl_axis.h.

vcsl_unit_sptr vcsl_axis::unit_ [protected]

Unit of the dimension.

Definition at line 94 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