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

Engine builder for commodity forward. More...

#include <ored/portfolio/builders/commodityforward.hpp>

+ Inheritance diagram for CommodityForwardEngineBuilder:
+ Collaboration diagram for CommodityForwardEngineBuilder:

Public Member Functions

 CommodityForwardEngineBuilder ()
 
- Public Member Functions inherited from CachingEngineBuilder< T, U, Args >
 CachingEngineBuilder (const string &model, const string &engine, const set< string > &tradeTypes)
 
QuantLib::ext::shared_ptr< U > engine (Args... params)
 Return a PricingEngine or a FloatingRateCouponPricer. More...
 
void reset () override
 reset the builder (e.g. clear cache) More...
 
- Public Member Functions inherited from EngineBuilder
 EngineBuilder (const string &model, const string &engine, const set< string > &tradeTypes)
 
virtual ~EngineBuilder ()
 Virtual destructor. More...
 
const string & model () const
 Return the model name. More...
 
const string & engine () const
 Return the engine name. More...
 
const set< string > & tradeTypes () const
 Return the possible trade types. More...
 
const string & configuration (const MarketContext &key)
 Return a configuration (or the default one if key not found) More...
 
virtual void reset ()
 reset the builder (e.g. clear cache) More...
 
void init (const QuantLib::ext::shared_ptr< Market > market, const map< MarketContext, string > &configurations, const map< string, string > &modelParameters, const map< string, string > &engineParameters, const std::map< std::string, std::string > &globalParameters={})
 Initialise this Builder with the market and parameters to use. More...
 
const set< std::pair< string, QuantLib::ext::shared_ptr< QuantExt::ModelBuilder > > > & modelBuilders () const
 return model builders More...
 
std::string engineParameter (const std::string &p, const std::vector< std::string > &qualifiers={}, const bool mandatory=true, const std::string &defaultValue="") const
 
std::string modelParameter (const std::string &p, const std::vector< std::string > &qualifiers={}, const bool mandatory=true, const std::string &defaultValue="") const
 

Protected Member Functions

virtual std::string keyImpl (const QuantLib::Currency &ccy) override
 
virtual QuantLib::ext::shared_ptr< QuantLib::PricingEngine > engineImpl (const QuantLib::Currency &ccy) override
 
- Protected Member Functions inherited from CachingEngineBuilder< T, U, Args >
virtual T keyImpl (Args...)=0
 
virtual QuantLib::ext::shared_ptr< U > engineImpl (Args...)=0
 

Additional Inherited Members

- Protected Attributes inherited from CachingEngineBuilder< T, U, Args >
map< T, QuantLib::ext::shared_ptr< U > > engines_
 
- Protected Attributes inherited from EngineBuilder
string model_
 
string engine_
 
set< string > tradeTypes_
 
QuantLib::ext::shared_ptr< Marketmarket_
 
map< MarketContext, string > configurations_
 
map< string, string > modelParameters_
 
map< string, string > engineParameters_
 
std::map< std::string, std::string > globalParameters_
 
set< std::pair< string, QuantLib::ext::shared_ptr< QuantExt::ModelBuilder > > > modelBuilders_
 

Detailed Description

Engine builder for commodity forward.

Pricing engines are cached by currency

Definition at line 38 of file commodityforward.hpp.

Constructor & Destructor Documentation

◆ CommodityForwardEngineBuilder()

Definition at line 41 of file commodityforward.hpp.

42 : CachingEngineBuilder("DiscountedCashflows", "DiscountingCommodityForwardEngine", {"CommodityForward"}) {}
CachingEngineBuilder(const string &model, const string &engine, const set< string > &tradeTypes)

Member Function Documentation

◆ keyImpl()

virtual std::string keyImpl ( const QuantLib::Currency &  ccy)
overrideprotectedvirtual

Definition at line 45 of file commodityforward.hpp.

45 {
46 return ccy.code();
47 }

◆ engineImpl()

virtual QuantLib::ext::shared_ptr< QuantLib::PricingEngine > engineImpl ( const QuantLib::Currency &  ccy)
overrideprotectedvirtual

Definition at line 49 of file commodityforward.hpp.

49 {
50 return QuantLib::ext::make_shared<QuantExt::DiscountingCommodityForwardEngine>(
51 market_->discountCurve(ccy.code(), configuration(MarketContext::pricing)));
52 }
QuantLib::ext::shared_ptr< Market > market_
const string & configuration(const MarketContext &key)
Return a configuration (or the default one if key not found)
+ Here is the call graph for this function: