QuantLib: a free/open-source library for quantitative finance
Fully annotated sources - version 1.32
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Related Functions | List of all members
PaymentTerm Class Reference

#include <ql/experimental/commodities/paymentterm.hpp>

+ Collaboration diagram for PaymentTerm:

Classes

struct  Data
 

Public Types

enum  EventType { TradeDate , PricingDate }
 

Public Member Functions

 PaymentTerm ()=default
 
 PaymentTerm (const std::string &name, EventType eventType, Integer offsetDays, const Calendar &calendar)
 

Related Functions

(Note that these are not member functions.)

bool operator== (const PaymentTerm &, const PaymentTerm &)
 
bool operator!= (const PaymentTerm &, const PaymentTerm &)
 
std::ostream & operator<< (std::ostream &, const PaymentTerm &)
 

Inspectors

ext::shared_ptr< Datadata_
 
static std::map< std::string, ext::shared_ptr< Data > > paymentTerms_
 
const std::string & name () const
 name, e.g, "Pricing end + 5 days" More...
 
EventType eventType () const
 
Integer offsetDays () const
 
const Calendarcalendar () const
 
bool empty () const
 
Date getPaymentDate (const Date &date) const
 

Detailed Description

Definition at line 33 of file paymentterm.hpp.

Member Enumeration Documentation

◆ EventType

enum EventType
Enumerator
TradeDate 
PricingDate 

Definition at line 35 of file paymentterm.hpp.

Constructor & Destructor Documentation

◆ PaymentTerm() [1/2]

PaymentTerm ( )
default

◆ PaymentTerm() [2/2]

PaymentTerm ( const std::string &  name,
PaymentTerm::EventType  eventType,
Integer  offsetDays,
const Calendar calendar 
)

Definition at line 27 of file paymentterm.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ name()

const std::string & name ( ) const

name, e.g, "Pricing end + 5 days"

Definition at line 89 of file paymentterm.hpp.

+ Here is the caller graph for this function:

◆ eventType()

PaymentTerm::EventType eventType ( ) const

Definition at line 93 of file paymentterm.hpp.

+ Here is the caller graph for this function:

◆ offsetDays()

Integer offsetDays ( ) const

Definition at line 97 of file paymentterm.hpp.

+ Here is the caller graph for this function:

◆ calendar()

const Calendar & calendar ( ) const

Definition at line 101 of file paymentterm.hpp.

+ Here is the caller graph for this function:

◆ empty()

bool empty ( ) const

Definition at line 109 of file paymentterm.hpp.

+ Here is the caller graph for this function:

◆ getPaymentDate()

Date getPaymentDate ( const Date date) const

Definition at line 105 of file paymentterm.hpp.

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==()

bool operator== ( const PaymentTerm ,
const PaymentTerm  
)
related

Definition at line 113 of file paymentterm.hpp.

+ Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const PaymentTerm ,
const PaymentTerm  
)
related

Definition at line 117 of file paymentterm.hpp.

◆ operator<<()

std::ostream & operator<< ( std::ostream &  ,
const PaymentTerm  
)
related

Definition at line 42 of file paymentterm.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ data_

ext::shared_ptr<Data> data_
protected

Definition at line 55 of file paymentterm.hpp.

◆ paymentTerms_

std::map< std::string, ext::shared_ptr< PaymentTerm::Data > > paymentTerms_
staticprotected

Definition at line 66 of file paymentterm.hpp.