QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.8
Public Member Functions | Protected Attributes | Related Functions | List of all members
Currency Class Reference

Currency specification More...

#include <ql/currency.hpp>

Inherited by ARSCurrency, ATSCurrency, AUDCurrency, BDTCurrency, BEFCurrency, BGLCurrency, BRLCurrency, BYRCurrency, CADCurrency, CHFCurrency, CLPCurrency, CNYCurrency, COPCurrency, CYPCurrency, CZKCurrency, DEMCurrency, DKKCurrency, EEKCurrency, ESPCurrency, EURCurrency, FIMCurrency, FRFCurrency, GBPCurrency, GRDCurrency, HKDCurrency, HUFCurrency, IDRCurrency, IEPCurrency, ILSCurrency, INRCurrency, IQDCurrency, IRRCurrency, ISKCurrency, ITLCurrency, JPYCurrency, KRWCurrency, KWDCurrency, 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, and ZARCurrency.

Public Member Functions

 Currency ()
 default constructor More...
 
Inspectors
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 Roundingrounding () const
 rounding convention
 
std::string format () const
 output format More...
 
Other information
bool empty () const
 is this a usable instance?
 
const CurrencytriangulationCurrency () const
 currency used for triangulated exchange when required
 

Protected Attributes

boost::shared_ptr< Data > data_
 

Related Functions

(Note that these are not member functions.)

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

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.

Friends And Related Function Documentation

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