com::ftlabs::fisa::DiscountSecurity Class Reference

#include <DiscountSecurity.h>

Inheritance diagram for com::ftlabs::fisa::DiscountSecurity:

com::ftlabs::fisa::MaturingSecurity com::ftlabs::fisa::AbstractSecurity com::ftlabs::fisa::Security List of all members.

Public Member Functions

 DiscountSecurity (const Market &market)
 DiscountSecurity (const DiscountSecurity &security)
 DiscountSecurity (const Market &market, const FISADate &maturityDate, const FISADate &datedDate)
 ~DiscountSecurity (void)
DiscountSecurityoperator= (const DiscountSecurity &security)
std::auto_ptr< const com::ftlabs::fisa::calc::DiscountCalculatorcreateCalculator (const FISADate &settlementDate, const HolidaySchedule *holidaySchedule=0) const throw ( com::ftlabs::fisa::calc::CalculationException )
 Create a Calculator object to use for this Security and for the period from the provided settlementDate to the default Redemption. It is up to the implementation to determine which Redemption to use if any, although this will usually be to maturity.
std::auto_ptr< const com::ftlabs::fisa::calc::DiscountCalculatorcreateCalculator (const FISADate &settlementDate, const Redemption &redemption, const HolidaySchedule *holidaySchedule=0) const throw ( com::ftlabs::fisa::calc::CalculationException )
 Create a Calculator for this Security and provided settlementDate to Redemption period.
void validateData (const FISADate &settlementDate, const FISADate &redemptionDate) const throw ( com::ftlabs::fisa::calc::CalculationException )
virtual const ClassID & getClassID (void) const

Static Public Attributes

static ClassID CLASSID

Protected Member Functions

virtual const com::ftlabs::fisa::calc::DiscountCalculatorcreateCalculatorImpl (const FISADate &settlementDate, const HolidaySchedule *holidaySchedule=0) const throw ( com::ftlabs::fisa::calc::CalculationException )
 Create a new Calculator pointer to be used for this Security and provided settlementDate. The maturity Redemption will be used with this settlementDate to create a new Calculator.
virtual const com::ftlabs::fisa::calc::DiscountCalculatorcreateCalculatorImpl (const FISADate &settlementDate, const Redemption &redemption, const HolidaySchedule *holidaySchedule=0) const throw ( com::ftlabs::fisa::calc::CalculationException )

Constructor & Destructor Documentation

com::ftlabs::fisa::DiscountSecurity::DiscountSecurity ( const Market market  ) 

com::ftlabs::fisa::DiscountSecurity::DiscountSecurity ( const DiscountSecurity security  ) 

com::ftlabs::fisa::DiscountSecurity::DiscountSecurity ( const Market market,
const FISADate maturityDate,
const FISADate datedDate 
)

com::ftlabs::fisa::DiscountSecurity::~DiscountSecurity ( void   ) 


Member Function Documentation

DiscountSecurity& com::ftlabs::fisa::DiscountSecurity::operator= ( const DiscountSecurity security  ) 

std::auto_ptr<const com::ftlabs::fisa::calc::DiscountCalculator> com::ftlabs::fisa::DiscountSecurity::createCalculator ( const FISADate settlementDate,
const HolidaySchedule holidaySchedule = 0 
) const throw ( com::ftlabs::fisa::calc::CalculationException )

Create a Calculator object to use for this Security and for the period from the provided settlementDate to the default Redemption. It is up to the implementation to determine which Redemption to use if any, although this will usually be to maturity.

Parameters:
settlementDate The binding settlementDate for which all calculations will be run.
holidaySchedule A pointer to a HolidaySchedule to be used for calculating True Yield. If 0, only weekend days will be used for cash flow date adjustments.

Returns:
An auto_ptr to a Calculator object to use for this Security and for the period from the provided settlementDate to the default Redemption. CalculationException

Reimplemented from com::ftlabs::fisa::Security.

std::auto_ptr<const com::ftlabs::fisa::calc::DiscountCalculator> com::ftlabs::fisa::DiscountSecurity::createCalculator ( const FISADate settlementDate,
const Redemption redemption,
const HolidaySchedule holidaySchedule = 0 
) const throw ( com::ftlabs::fisa::calc::CalculationException )

Create a Calculator for this Security and provided settlementDate to Redemption period.

Parameters:
settlementDate the binding settlementDate for which all calculations will be run.
redemption the binding Redemption to which all calculations will be run. A pointer to a HolidaySchedule to be used for calculating True Yield. If 0, only weekend days will be used for cash flow date adjustments. an auto_ptr to a Calculator for this Security and provided settlementDate to Redemption period. CalculationException

Reimplemented from com::ftlabs::fisa::Security.

void com::ftlabs::fisa::DiscountSecurity::validateData ( const FISADate settlementDate,
const FISADate redemptionDate 
) const throw ( com::ftlabs::fisa::calc::CalculationException )

virtual const ClassID& com::ftlabs::fisa::DiscountSecurity::getClassID ( void   )  const [virtual]

Implements com::ftlabs::fisa::Security.

virtual const com::ftlabs::fisa::calc::DiscountCalculator* com::ftlabs::fisa::DiscountSecurity::createCalculatorImpl ( const FISADate settlementDate,
const HolidaySchedule holidaySchedule = 0 
) const throw ( com::ftlabs::fisa::calc::CalculationException ) [protected, virtual]

Create a new Calculator pointer to be used for this Security and provided settlementDate. The maturity Redemption will be used with this settlementDate to create a new Calculator.

Parameters:
settlementDate The binding settlementDate for which all calculations will be run.
holidaySchedule A pointer to a HolidaySchedule to be used for calculating True Yield. If 0, only weekend days will be used for cash flow date adjustments.

Returns:
A Calculator pointer to be used for this Security and provided settlement date to maturity Redemption period. CalculationException

Reimplemented from com::ftlabs::fisa::MaturingSecurity.

virtual const com::ftlabs::fisa::calc::DiscountCalculator* com::ftlabs::fisa::DiscountSecurity::createCalculatorImpl ( const FISADate settlementDate,
const Redemption redemption,
const HolidaySchedule holidaySchedule = 0 
) const throw ( com::ftlabs::fisa::calc::CalculationException ) [protected, virtual]

Implements com::ftlabs::fisa::Security.


Member Data Documentation

ClassID com::ftlabs::fisa::DiscountSecurity::CLASSID [static]


The documentation for this class was generated from the following file:
Generated on Tue Feb 5 03:50:26 2008 for FTLabs FISA (c++) by  doxygen 1.5.2