ddl::DDUnit Class Reference

The unit class holding a reference to its complete DD (references to baseunits and prefixes) More...

#include <ddunit.h>

Public Member Functions
	DDUnit ()=delete
	no default CTOR
	DDUnit (const DDUnit &)
	copy CTOR
	DDUnit (DDUnit &&)
	move CTOR
DDUnit &	operator= (const DDUnit &)
	copy assignment operator
DDUnit &	operator= (DDUnit &&)
	move assignment operator
	DDUnit (const std::string &name, const std::string &numerator, const std::string &denominator, const std::string &offset, const std::vector< DDRefUnit > &ref_units={})
	CTOR.
void	addRefUnit (const DDRefUnit &ref_unit)
	adding a refunit
const dd::Unit &	getUnit () const
	Get the Unit object.
const dd::DataDefinition &	getDD () const
	Get the data definiton.

Detailed Description

The unit class holding a reference to its complete DD (references to baseunits and prefixes)

Constructor & Destructor Documentation

DDUnit()

ddl::DDUnit::DDUnit	(	const std::string &	name,
		const std::string &	numerator,
		const std::string &	denominator,
		const std::string &	offset,
		const std::vector< DDRefUnit > &	ref_units = {} )

CTOR.

Parameters

name	the name of the unit
numerator	the numerator for the unit
denominator	the denominator for the unit
offset	the offset for the unit
ref_units	vector of refunits

Exceptions

dd::Error

this will throw if this list contains a base_unit/prefix pair twice

Member Function Documentation

addRefUnit()

void ddl::DDUnit::addRefUnit

(

const DDRefUnit &

ref_unit

)

adding a refunit

Parameters

ref_unit

the refunit to add

Exceptions

dd::Error

this will throw if this refUnits already contains a base_unit/prefix pair

getDD()

const dd::DataDefinition & ddl::DDUnit::getDD

(

)

const

Get the data definiton.

Returns

const dd::DataDefinition&

getUnit()

const dd::Unit & ddl::DDUnit::getUnit

(

)

const

Get the Unit object.

Returns

const dd::Unit&

operator=() [1/2]

DDUnit & ddl::DDUnit::operator=

(

const DDUnit &

)

copy assignment operator

Returns

DDUnit&

operator=() [2/2]

DDUnit & ddl::DDUnit::operator=

(

DDUnit &&

)

move assignment operator

Returns

DDUnit&

---

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

• include/ddl/dd/ddunit.h