ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PredefinedUnits

Static class for predefined units. More...

#include <dd_predefined_units.h>

Public Member Functions

std::shared_ptr< dd::datamodel::BaseUnitgetPredefinedBaseUnit (const std::string &name) const
 Get the Predefined Base Unit by name.
 
std::shared_ptr< dd::datamodel::UnitPrefixgetPredefinedUnitPrefix (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 PredefinedUnitsgetInstance ()
 Get the Instance object.
 

Private Member Functions

 PredefinedUnits ()
 Construct a new Predefined Units object.
 
 ~PredefinedUnits ()
 Destructor.
 

Private Attributes

const std::unordered_map< std::string, std::shared_ptr< dd::datamodel::BaseUnit > > _defined_base_units
 
const std::unordered_map< std::string, std::shared_ptr< dd::datamodel::UnitPrefix > > _defined_unit_prefixes
 

Detailed Description

Static class for predefined units.

Following predefined base units can be used:

Following predefined unit prefixes can be used:

Definition at line 179 of file dd_predefined_units.h.

Member Function Documentation

◆ getInstance()

static const PredefinedUnits & getInstance ( )
static

Get the Instance object.

Returns
PredefinedUnits&

References PredefinedUnits().

◆ getPredefinedBaseUnit()

std::shared_ptr< dd::datamodel::BaseUnit > getPredefinedBaseUnit ( const std::string & name) const

Get the Predefined Base Unit by name.

Parameters
namethe name of the predefined base unit.
Returns
std::shared_ptr<dd::datamodel::BaseUnit>

◆ getPredefinedBaseUnits()

std::vector< std::shared_ptr< dd::datamodel::BaseUnit > > 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 > getPredefinedUnitPrefix ( const std::string & name) const

Get the Predefined Unit Prefix by name.

Parameters
namethe name of the unit prefix
Returns
std::shared_ptr<dd::datamodel::UnitPrefix>

◆ getPredefinedUnitPrefixes()

std::vector< std::shared_ptr< dd::datamodel::UnitPrefix > > 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.

Member Data Documentation

◆ _defined_base_units

const std::unordered_map<std::string, std::shared_ptr<dd::datamodel::BaseUnit> > _defined_base_units
private

Definition at line 230 of file dd_predefined_units.h.

◆ _defined_unit_prefixes

const std::unordered_map<std::string, std::shared_ptr<dd::datamodel::UnitPrefix> > _defined_unit_prefixes
private

Definition at line 232 of file dd_predefined_units.h.