ddl::PredefinedUnits Class Reference

Static class for predefined units. More...

#include <dd_predefined_units.h>

Public Member Functions
std::shared_ptr< dd::datamodel::BaseUnit >	getPredefinedBaseUnit (const std::string &name) const
	Get the Predefined Base Unit by name.
std::shared_ptr< dd::datamodel::UnitPrefix >	getPredefinedUnitPrefix (const std::string &name) const
	Get the Predefined Unit Prefix by name.
std::vector< std::shared_ptr< dd::datamodel::BaseUnit > >	getPredefinedBaseUnits () const
	Gets a vector of all the predefined base units.
std::vector< std::shared_ptr< dd::datamodel::UnitPrefix > >	getPredefinedUnitPrefixes () const
	Gets a vector of all the predefined unit prefixes types.

Static Public Member Functions
static const PredefinedUnits &	getInstance ()
	Get the Instance object.

Detailed Description

Static class for predefined units.

Following predefined base units can be used:

• unit::Metre::_name - "Metre" - BaseUnit<unit::Metre>>()
• unit::Kilogram::_name - "Kilogram" - BaseUnit<unit::Kilogram>>()
• unit::Second::_name - "Second" - BaseUnit<unit::Second>>()
• unit::Ampere::_name - "Ampere" - BaseUnit<unit::Ampere>>()
• unit::Kelvin::_name - "Kelvin" - BaseUnit<unit::Kelvin>>()
• unit::Mole::_name - "Mole" - BaseUnit<unit::Mole>>()
• unit::Candela::_name - "Candela" - BaseUnit<unit::Candela>>()
• unit::Degree::_name - "Degree" - BaseUnit<unit::Degree>>()
• unit::Radiant::_name - "Radiant" - BaseUnit<unit::Radiant>>()
• unit::Unitless::_name - "Unitless" - BaseUnit<unit::Unitless>>()
• unit::Nou::_name - "nou" - BaseUnit<unit::Nou>>()

Following predefined unit prefixes can be used:

• unit_prefix::yotta::_name - "yotta" - UnitPrefix<unit_prefix::yotta>>()
• unit_prefix::zetta::_name - "zetta" - UnitPrefix<unit_prefix::zetta>>()
• unit_prefix::exa::_name - "exa" - UnitPrefix<unit_prefix::exa>>()
• unit_prefix::peta::_name - "peta" - UnitPrefix<unit_prefix::peta>>()
• unit_prefix::tera::_name - "yotta" - UnitPrefix<unit_prefix::tera>>()
• unit_prefix::giga::_name - "giga" - UnitPrefix<unit_prefix::giga>>()
• unit_prefix::mega::_name - "mega" - UnitPrefix<unit_prefix::mega>>()
• unit_prefix::kilo::_name - "kilo" - UnitPrefix<unit_prefix::kilo>>()
• unit_prefix::hecto::_name - "hecto" - UnitPrefix<unit_prefix::hecto>>()
• unit_prefix::deca::_name - "deca" - UnitPrefix<unit_prefix::deca>>()
• unit_prefix::deci::_name - "deci" - UnitPrefix<unit_prefix::deci>>()
• unit_prefix::centi::_name - "centi" - UnitPrefix<unit_prefix::centi>>()
• unit_prefix::milli::_name - "milli" - UnitPrefix<unit_prefix::milli>>()
• unit_prefix::micro::_name - "micro" - UnitPrefix<unit_prefix::micro>>()
• unit_prefix::nano::_name - "nano" - UnitPrefix<unit_prefix::nano>>()
• unit_prefix::micro::_name - "micro" - UnitPrefix<unit_prefix::micro>>()
• unit_prefix::pico::_name - "pico" - UnitPrefix<unit_prefix::pico>>()
• unit_prefix::femto::_name - "femto" - UnitPrefix<unit_prefix::femto>>()
• unit_prefix::atto::_name - "atto" - UnitPrefix<unit_prefix::atto>>()
• unit_prefix::zepto::_name - "zepto" - UnitPrefix<unit_prefix::zepto>>()
• unit_prefix::yocto::_name - "yocto" - UnitPrefix<unit_prefix::yocto>>()

Member Function Documentation

getInstance()

static const PredefinedUnits & ddl::PredefinedUnits::getInstance ( )

static

Get the Instance object.

Returns

PredefinedUnits&

getPredefinedBaseUnit()

std::shared_ptr< dd::datamodel::BaseUnit > ddl::PredefinedUnits::getPredefinedBaseUnit

(

const std::string &

name

)

const

Get the Predefined Base Unit by name.

Parameters

name	the name of the predefined base unit.

Returns

std::shared_ptr<dd::datamodel::BaseUnit>

getPredefinedBaseUnits()

std::vector< std::shared_ptr< dd::datamodel::BaseUnit > > ddl::PredefinedUnits::getPredefinedBaseUnits

(

)

const

Gets a vector of all the predefined base units.

Returns

std::vector<std::shared_ptr<dd::datamodel::BaseUnit>> The predefined base units.

getPredefinedUnitPrefix()

std::shared_ptr< dd::datamodel::UnitPrefix > ddl::PredefinedUnits::getPredefinedUnitPrefix

(

const std::string &

name

)

const

Get the Predefined Unit Prefix by name.

Parameters

name	the name of the unit prefix

Returns

std::shared_ptr<dd::datamodel::UnitPrefix>

getPredefinedUnitPrefixes()

std::vector< std::shared_ptr< dd::datamodel::UnitPrefix > > ddl::PredefinedUnits::getPredefinedUnitPrefixes

(

)

const

Gets a vector of all the predefined unit prefixes types.

Returns

std::vector<std::shared_ptr<dd::datamodel::UnitPrefix>> The predefined unit prefixes.

---

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

• include/ddl/dd/dd_predefined_units.h