QuantLib_Currency man page

Currency — Currency specification  


#include <ql/currency.hpp>

Inherited by ARSCurrency, ATSCurrency, AUDCurrency, BCHCurrency, BDTCurrency, BEFCurrency, BGLCurrency, BRLCurrency, BTCCurrency, BYRCurrency, CADCurrency, CHFCurrency, CLPCurrency, CNYCurrency, COPCurrency, CYPCurrency, CZKCurrency, DASHCurrency, DEMCurrency, DKKCurrency, EEKCurrency, ESPCurrency, ETCCurrency, ETHCurrency, EURCurrency, FIMCurrency, FRFCurrency, GBPCurrency, GRDCurrency, HKDCurrency, HUFCurrency, IDRCurrency, IEPCurrency, ILSCurrency, INRCurrency, IQDCurrency, IRRCurrency, ISKCurrency, ITLCurrency, JPYCurrency, KRWCurrency, KWDCurrency, LTCCurrency, LTLCurrency, LUFCurrency, LVLCurrency, MTLCurrency, MXNCurrency, MYRCurrency, NLGCurrency, NOKCurrency, NPRCurrency, NZDCurrency, PEHCurrency, PEICurrency, PENCurrency, PKRCurrency, PLNCurrency, PTECurrency, ROLCurrency, RONCurrency, RUBCurrency, SARCurrency, SEKCurrency, SGDCurrency, SITCurrency, SKKCurrency, THBCurrency, TRLCurrency, TRYCurrency, TTDCurrency, TWDCurrency, UAHCurrency, USDCurrency, VEBCurrency, VNDCurrency, XRPCurrency, ZARCurrency, and ZECCurrency.

Public Member Functions

Currency ()
default constructor


const std::string & name () const
currency name, e.g, 'U.S. Dollar'
const std::string & code () const
ISO 4217 three-letter code, e.g, 'USD'.
Integer numericCode () const
ISO 4217 numeric code, e.g, '840'.
const std::string & symbol () const
symbol, e.g, '$'
const std::string & fractionSymbol () const
fraction symbol, e.g, '¢'
Integer fractionsPerUnit () const
number of fractionary parts in a unit, e.g, 100
const Rounding & rounding () const
rounding convention
std::string format () const
output format

Other information

bool empty () const
is this a usable instance?
const Currency & triangulationCurrency () const
currency used for triangulated exchange when required

Protected Attributes

boost::shared_ptr< Data > data_

Detailed Description

Currency specification

Constructor & Destructor Documentation

Currency ()

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.

Member Function Documentation

std::string format () const

output format The format will be fed three positional parameters, namely, value, code, and symbol, in this order.


Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

The man pages Currency(3), fractionsPerUnit(3), fractionSymbol(3), numericCode(3), ql-format(3), rounding(3), symbol(3) and triangulationCurrency(3) are aliases of QuantLib_Currency(3).

Mon Apr 30 2018 Version 1.12.1 QuantLib