FISA C++
com::ftlabs::fisa::CPIFactory Class Referenceabstract
Inheritance diagram for com::ftlabs::fisa::CPIFactory:
com::ftlabs::fisa::DefaultCPIFactory

Public Member Functions

virtual double getCPI (int year, int month) const =0
 This method returns the CPI for the given year and month. More...
 
virtual double getCPI (int year, int month, int monthOffset) const =0
 This method returns the CPI for the given month offset from year and month. More...
 
virtual double getCPI (const FISADate &date) const =0
 This method returns the CPI for the given Date. More...
 
virtual double getCPI (const FISADate &date, int monthOffset) const =0
 This method returns the CPI for the given month offset from the given date. More...
 
virtual double getIndexRatio (const FISADate &datedDate, const FISADate &settlementDate) const =0
 Returns the index ratio for a given datedDate and settlementDate. More...
 

Member Function Documentation

◆ getCPI() [1/4]

virtual double com::ftlabs::fisa::CPIFactory::getCPI ( const FISADate date) const
pure virtual

This method returns the CPI for the given Date.

Parameters
dateA Date
Returns
CPI for the given Date.

Implemented in com::ftlabs::fisa::DefaultCPIFactory.

◆ getCPI() [2/4]

virtual double com::ftlabs::fisa::CPIFactory::getCPI ( const FISADate date,
int  monthOffset 
) const
pure virtual

This method returns the CPI for the given month offset from the given date.

Parameters
dateA date
monthOffsetMonths from the given month.
Returns
CPI for the given offset from the given date.

Implemented in com::ftlabs::fisa::DefaultCPIFactory.

◆ getCPI() [3/4]

virtual double com::ftlabs::fisa::CPIFactory::getCPI ( int  year,
int  month 
) const
pure virtual

This method returns the CPI for the given year and month.

Parameters
yearThe year
monthThe month
Returns
CPI for the given year and month.

Implemented in com::ftlabs::fisa::DefaultCPIFactory.

◆ getCPI() [4/4]

virtual double com::ftlabs::fisa::CPIFactory::getCPI ( int  year,
int  month,
int  monthOffset 
) const
pure virtual

This method returns the CPI for the given month offset from year and month.

Parameters
yearThe year
monthThe month
monthOffsetMonths from the given month.
Returns
CPI for the given offset from year and month.

Implemented in com::ftlabs::fisa::DefaultCPIFactory.

◆ getIndexRatio()

virtual double com::ftlabs::fisa::CPIFactory::getIndexRatio ( const FISADate datedDate,
const FISADate settlementDate 
) const
pure virtual

Returns the index ratio for a given datedDate and settlementDate.

Parameters
datedDateThe datedDate of the Security.
settlementDateThe settlementDate for a given transaction.
Returns
The index ratio for the given datedDate and settlementDate.

Implemented in com::ftlabs::fisa::DefaultCPIFactory.