QuantLib::Settings

Settings Class Reference

#include <ql/settings.hpp>

Inheritance diagram for Settings:

Inheritance graph
[legend]
List of all members.

Detailed Description

global repository for run-time library settings


Public Member Functions

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

Friends

class Singleton< Settings >
std::ostream & operator<< (std::ostream &, const DateProxy &)

Member Function Documentation

Settings::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.

QuantLib.org
QuantLib 		Hosted by
SourceForge.net Logo 		Documentation generated by
doxygen