QuantLib_CommodityType (3) - Linux Manuals

QuantLib_CommodityType: commodity type

NAME

QuantLib::CommodityType - commodity type

SYNOPSIS

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

Inherited by NullCommodityType.

Public Member Functions

CommodityType ()
default constructor
CommodityType (const std::string &code, const std::string &name)

Inspectors

const std::string & code () const
commodity code, e.g, 'HO'
const std::string & name () const
name, e.g, 'Heating Oil'

Other information

bool empty () const
is this a usable instance?

Protected Attributes

boost::shared_ptr< Data > data_

Static Protected Attributes

static std::map< std::string, boost::shared_ptr< Data > > commodityTypes_

Related Functions

(Note that these are not member functions.)
bool operator== (const CommodityType &, const CommodityType &)

bool operator!= (const CommodityType &, const CommodityType &)

std::ostream & operator<< (std::ostream &, const CommodityType &)

Detailed Description

commodity type

Constructor & Destructor Documentation

CommodityType ()

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.

Friends And Related Function Documentation

bool operator== (const CommodityType &, const CommodityType &) [related]

bool operator!= (const CommodityType &, const CommodityType &) [related]

std::ostream & operator<< (std::ostream &, const CommodityType &) [related]

Author

Generated automatically by Doxygen for QuantLib from the source code.