QuantLib_Settings (3) - Linux Man Pages

QuantLib_Settings: global repository for run-time library settings

NAME

QuantLib::Settings - global repository for run-time library settings

SYNOPSIS


#include <ql/settings.hpp>

Inherits Singleton< Settings >.

Public Member Functions


DateProxy & evaluationDate ()
the date at which pricing is to be performed.
const DateProxy & evaluationDate () const

bool & enforcesTodaysHistoricFixings ()

bool enforcesTodaysHistoricFixings () const

Friends


class Singleton< Settings >

std::ostream & operator<< (std::ostream &, const DateProxy &)

Detailed Description

global repository for run-time library settings

Member Function Documentation

DateProxy& evaluationDate ()

the date at which pricing is to be performed.

Client code can inspect the evaluation date, as in:

            Date d = Settings::instance().evaluationDate();


 where today's date is returned if the evaluation date is set to the null date (its default value;) can set it to a new value, as in: 

            Settings::instance().evaluationDate() = d;


 and can register with it, as in: 

            registerWith(Settings::instance().evaluationDate());


 to be notified when it is set to a new value. 

Warning

a notification is not sent when the evaluation date changes for natural causes---i.e., a date was not explicitly set (which results in today's date being used for pricing) and the current date changes as the clock strikes midnight.

Author

Generated automatically by Doxygen for QuantLib from the source code.