ObservationMode Class Reference

The Global Observation setting. More...

#include <orea/engine/observationmode.hpp>

Inheritance diagram for ObservationMode:

Collaboration diagram for ObservationMode:

Public Types
enum class	Mode { None , Disable , Defer , Unregister }
	Allowable mode mode. More...

Public Member Functions
Mode	mode ()
void	setMode (Mode s)
void	setMode (const std::string &s)

Private Member Functions
	ObservationMode ()

Private Attributes
Mode	mode_

Friends
class	QuantLib::Singleton< ObservationMode >

Detailed Description

The Global Observation setting.

This singleton is used in ORE to control the usage of the QuantLib::ObservableSettings

Definition at line 36 of file observationmode.hpp.

Member Enumeration Documentation

Mode

enum class Mode

strong

Allowable mode mode.

Enumerator
None
Disable
Defer
Unregister

Definition at line 44 of file observationmode.hpp.

{ None, Disable, Defer, Unregister };

Constructor & Destructor Documentation

ObservationMode()

ObservationMode ( )

private

Definition at line 40 of file observationmode.hpp.

: mode_(Mode::None) {}

Member Function Documentation

mode()

Mode mode

(

)

Definition at line 46 of file observationmode.hpp.

{ return mode_; }

setMode() [1/2]

void setMode

(

Mode

s

)

Definition at line 48 of file observationmode.hpp.

{ mode_ = s; }

setMode() [2/2]

void setMode

(

const std::string &

s

)

Definition at line 50 of file observationmode.hpp.

                                     {
        if (s == "None")
            mode_ = Mode::None;
        else if (s == "Disable")
            mode_ = Mode::Disable;
        else if (s == "Defer")
            mode_ = Mode::Defer;
        else if (s == "Unregister")
            mode_ = Mode::Unregister;
        else {
            QL_FAIL("Invalid ObserverMode string " << s);
        }
    }

Friends And Related Function Documentation

QuantLib::Singleton< ObservationMode >

friend class QuantLib::Singleton< ObservationMode >

friend

Definition at line 1 of file observationmode.hpp.

Member Data Documentation

mode_

Mode mode_

private

Definition at line 65 of file observationmode.hpp.