Logo
Fully annotated reference manual - version 1.8.12
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
StaticScenarioGenerator Class Reference

#include <orea/scenario/scenariogenerator.hpp>

+ Inheritance diagram for StaticScenarioGenerator:
+ Collaboration diagram for StaticScenarioGenerator:

Public Member Functions

 StaticScenarioGenerator ()
 
void reset () override
 Reset the generator so calls to next() return the first scenario. More...
 
QuantLib::ext::shared_ptr< ore::analytics::Scenarionext (const Date &) override
 Return the next scenario for the given date. More...
 
void setScenario (const QuantLib::ext::shared_ptr< ore::analytics::Scenario > &s)
 
- Public Member Functions inherited from ScenarioGenerator
virtual ~ScenarioGenerator ()
 Default destructor. More...
 
virtual QuantLib::ext::shared_ptr< Scenarionext (const Date &d)=0
 Return the next scenario for the given date. More...
 
virtual void reset ()=0
 Reset the generator so calls to next() return the first scenario. More...
 

Private Attributes

QuantLib::ext::shared_ptr< ore::analytics::Scenarios_
 

Detailed Description

Definition at line 100 of file scenariogenerator.hpp.

Constructor & Destructor Documentation

◆ StaticScenarioGenerator()

Definition at line 102 of file scenariogenerator.hpp.

102{}

Member Function Documentation

◆ reset()

void reset ( )
overridevirtual

Reset the generator so calls to next() return the first scenario.

This allows re-generation of scenarios if required.

Implements ScenarioGenerator.

Definition at line 104 of file scenariogenerator.hpp.

104{}

◆ next()

QuantLib::ext::shared_ptr< ore::analytics::Scenario > next ( const Date &  d)
overridevirtual

Return the next scenario for the given date.

Implements ScenarioGenerator.

Definition at line 105 of file scenariogenerator.hpp.

105{ return s_; }
QuantLib::ext::shared_ptr< ore::analytics::Scenario > s_

◆ setScenario()

void setScenario ( const QuantLib::ext::shared_ptr< ore::analytics::Scenario > &  s)

Definition at line 107 of file scenariogenerator.hpp.

107{ s_ = s; }

Member Data Documentation

◆ s_

QuantLib::ext::shared_ptr<ore::analytics::Scenario> s_
private

Definition at line 110 of file scenariogenerator.hpp.