1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2008 J. Erik Radmall
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<http://quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file commodity.hpp
\brief commodity type
*/
#ifndef quantlib_commodity_type_hpp
#define quantlib_commodity_type_hpp
#include <ql/qldefines.hpp>
#include <boost/shared_ptr.hpp>
#include <map>
#include <iosfwd>
#include <string>
namespace QuantLib {
//! commodity type
class CommodityType {
public:
//! 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.
*/
CommodityType() {}
CommodityType(const std::string& code, const std::string& name);
//! \name Inspectors
//@{
//! commodity code, e.g, "HO"
const std::string& code() const;
//! name, e.g, "Heating Oil"
const std::string& name() const;
// commodity code
//@}
//! \name Other information
//@{
//! is this a usable instance?
bool empty() const;
//@}
protected:
struct Data;
boost::shared_ptr<Data> data_;
struct Data {
std::string name, code;
Data(const std::string& name,
const std::string& code)
: name(name), code(code) {}
};
static std::map<std::string, boost::shared_ptr<Data> > commodityTypes_;
};
/*! \relates CommodityType */
bool operator==(const CommodityType&,
const CommodityType&);
/*! \relates CommodityType */
bool operator!=(const CommodityType&,
const CommodityType&);
/*! \relates CommodityType */
std::ostream& operator<<(std::ostream&,
const CommodityType&);
class NullCommodityType : public CommodityType {
public:
NullCommodityType() :
CommodityType("<NULL>", "<NULL>") {}
};
inline const std::string& CommodityType::code() const {
return data_->code;
}
inline const std::string& CommodityType::name() const {
return data_->name;
}
inline bool CommodityType::empty() const {
return !data_;
}
inline bool operator==(const CommodityType& c1, const CommodityType& c2) {
return c1.code() == c2.code();
}
inline bool operator!=(const CommodityType& c1, const CommodityType& c2) {
return !(c1 == c2);
}
}
#endif
|
