com::ftlabs::fisa::MaturingCallableSecurity Class Reference

#include <MaturingCallableSecurity.h>

Inheritance diagram for com::ftlabs::fisa::MaturingCallableSecurity:

com::ftlabs::fisa::MaturingSecurity com::ftlabs::fisa::AbstractSecurity com::ftlabs::fisa::Security com::ftlabs::fisa::InterestAtMaturitySecurity com::ftlabs::fisa::PeriodicInterestPaymentSecurity com::ftlabs::fisa::ZeroCouponSecurity com::ftlabs::fisa::FixedInterestRateSecurity com::ftlabs::fisa::SteppedCouponSecurity com::ftlabs::fisa::IndexLinkedSecurity com::ftlabs::fisa::InflationIndexedSecurity List of all members.

Public Member Functions

void setCallSchedule (CallSchedule *callSchedule)
CallSchedulegetCallSchedule (void)
virtual std::auto_ptr< com::ftlabs::fisa::calc::QuoteAnalyticscreateQuoteAnalytics (const com::ftlabs::fisa::calc::Quote &quote, const FISADate &settlementDate, const HolidaySchedule *holidaySchedule=0) const throw ( com::ftlabs::fisa::calc::CalculationException )
 Create a new Calculator for this Security and provided settlementDate. The maturity Redemption will be used with this settlementDate to create a new Calculator.
virtual int getRedemptionCount (void)
 Get the number of Redemptions set for this Security, including any calls and maturity.
virtual const RedemptiongetRedemption (int index)
 Get a pointer to the Redemption at the specified index.

Protected Member Functions

 MaturingCallableSecurity (const Market &market, const Security::ClassID &classID)
 MaturingCallableSecurity (const MaturingCallableSecurity &security)
 ~MaturingCallableSecurity (void)
MaturingCallableSecurityoperator= (const MaturingCallableSecurity &security)

Private Attributes

CallSchedulecallSchedule

Constructor & Destructor Documentation

com::ftlabs::fisa::MaturingCallableSecurity::MaturingCallableSecurity ( const Market market,
const Security::ClassID classID 
) [protected]

com::ftlabs::fisa::MaturingCallableSecurity::MaturingCallableSecurity ( const MaturingCallableSecurity security  )  [protected]

com::ftlabs::fisa::MaturingCallableSecurity::~MaturingCallableSecurity ( void   )  [protected]


Member Function Documentation

MaturingCallableSecurity& com::ftlabs::fisa::MaturingCallableSecurity::operator= ( const MaturingCallableSecurity security  )  [protected]

void com::ftlabs::fisa::MaturingCallableSecurity::setCallSchedule ( CallSchedule callSchedule  ) 

CallSchedule* com::ftlabs::fisa::MaturingCallableSecurity::getCallSchedule ( void   ) 

virtual std::auto_ptr<com::ftlabs::fisa::calc::QuoteAnalytics> com::ftlabs::fisa::MaturingCallableSecurity::createQuoteAnalytics ( const com::ftlabs::fisa::calc::Quote quote,
const FISADate settlementDate,
const HolidaySchedule holidaySchedule = 0 
) const throw ( com::ftlabs::fisa::calc::CalculationException ) [virtual]

Create a new Calculator 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 for this Security and provided settlement date to maturity Redemption period. CalculationException virtual std::auto_ptr<const com::ftlabs::fisa::calc::Calculator> createCalculator( const FISADate &settlementDate, const HolidaySchedule *holidaySchedule = 0 ) const throw ( com::ftlabs::fisa::calc::CalculationException );

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

virtual int com::ftlabs::fisa::MaturingCallableSecurity::getRedemptionCount ( void   )  [virtual]

Get the number of Redemptions set for this Security, including any calls and maturity.

Returns:
The number of redemptions set for this Security.

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

virtual const Redemption* com::ftlabs::fisa::MaturingCallableSecurity::getRedemption ( int  index  )  [virtual]

Get a pointer to the Redemption at the specified index.

Parameters:
index The index of the Redemption to return. A valid index would be from 0 through getRedemptionCount() - 1.
Returns:
A pointer to the Redemption at the specified index.

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


Member Data Documentation

CallSchedule* com::ftlabs::fisa::MaturingCallableSecurity::callSchedule [private]


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