QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.20
Public Types | Public Member Functions | Related Functions | List of all members
UnitOfMeasure Class Reference

Unit of measure specification More...

#include <ql/experimental/commodities/unitofmeasure.hpp>

Inherited by BarrelUnitOfMeasure, GallonUnitOfMeasure, KilolitreUnitOfMeasure, LitreUnitOfMeasure, LotUnitOfMeasure, MBUnitOfMeasure, MTUnitOfMeasure, and TokyoKilolitreUnitOfMeasure.

Public Types

enum  Type { Mass, Volume, Energy, Quantity }
 

Public Member Functions

 UnitOfMeasure ()
 default constructor More...
 
 UnitOfMeasure (const std::string &name, const std::string &code, Type unitType)
 
Inspectors
const std::string & name () const
 name, e.g, "Barrels"
 
const std::string & code () const
 code, e.g, "BBL", "MT"
 
Type unitType () const
 unit type (mass, volume...)
 

Related Functions

(Note that these are not member functions.)

bool operator== (const UnitOfMeasure &, const UnitOfMeasure &)
 
bool operator!= (const UnitOfMeasure &, const UnitOfMeasure &)
 
std::ostream & operator<< (std::ostream &, const UnitOfMeasure &)
 

Other information

ext::shared_ptr< Data > data_
 
bool empty () const
 is this a usable instance?
 
const Roundingrounding () const
 
const UnitOfMeasuretriangulationUnitOfMeasure () const
 unit used for triangulation when required
 

Detailed Description

Unit of measure specification

Constructor & Destructor Documentation

◆ UnitOfMeasure()

default constructor

Instances built via this constructor have undefined behavior. Such instances can only act as placeholders and must be reassigned to a valid currency before being used.