QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.38
Loading...
Searching...
No Matches
quote.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2007 Ferdinando Ametrano
5 Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
6
7 This file is part of QuantLib, a free-software/open-source library
8 for financial quantitative analysts and developers - http://quantlib.org/
9
10 QuantLib is free software: you can redistribute it and/or modify it
11 under the terms of the QuantLib license. You should have received a
12 copy of the license along with this program; if not, please email
13 <quantlib-dev@lists.sf.net>. The license is also available online at
14 <http://quantlib.org/license.shtml>.
15
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the license for more details.
19*/
20
21/*! \file quote.hpp
22 \brief purely virtual base class for market observables
23*/
24
25#ifndef quantlib_quote_hpp
26#define quantlib_quote_hpp
27
28#include <ql/handle.hpp>
29#include <ql/errors.hpp>
30#include <ql/utilities/null.hpp>
31#include <variant>
32
33namespace QuantLib {
34
35 //! purely virtual base class for market observables
36 /*! \test the observability of class instances is tested.
37 */
38 class Quote : public virtual Observable {
39 public:
40 ~Quote() override = default;
41 //! returns the current value
42 virtual Real value() const = 0;
43 //! returns true if the Quote holds a valid value
44 virtual bool isValid() const = 0;
45 };
46
47
48 Handle<Quote> handleFromVariant(const std::variant<Real, Handle<Quote>>& value);
49
50}
51
52#endif
Shared handle to an observable.
Definition: handle.hpp:41
Object that notifies its changes to a set of observers.
Definition: observable.hpp:62
purely virtual base class for market observables
Definition: quote.hpp:38
virtual bool isValid() const =0
returns true if the Quote holds a valid value
virtual Real value() const =0
returns the current value
~Quote() override=default
Classes and functions for error handling.
QL_REAL Real
real number
Definition: types.hpp:50
Globally accessible relinkable pointer.
Definition: any.hpp:37
Handle< Quote > handleFromVariant(const std::variant< Real, Handle< Quote > > &value)
Definition: quote.cpp:27
null values