com::ftlabs::fisa::DefaultSettlementDateFactory Class Reference

#include <DefaultSettlementDateFactory.h>

Inheritance diagram for com::ftlabs::fisa::DefaultSettlementDateFactory:

com::ftlabs::fisa::SettlementDateFactory List of all members.

Public Member Functions

 DefaultSettlementDateFactory (void)
 Creates a DefaultSettlementDateFactory without a default HolidaySchedule.
 DefaultSettlementDateFactory (const HolidaySchedule *defaultHolidaySchedule)
 Creates a DefaultSettlementDateFactory that utilizes the provided HolidaySchedule to determine if a date is a holiday.
 DefaultSettlementDateFactory (const DefaultSettlementDateFactory &factory)
virtual ~DefaultSettlementDateFactory (void)
DefaultSettlementDateFactoryoperator= (const DefaultSettlementDateFactory &factory)
FISADate getSettlementDate (int settlementDays) const
 Gets a settlement date using today as the trade date.
FISADate getSettlementDate (const FISADate &tradeDate, int settlementDays) const
 Gets a settlement date using the provided trade date.
FISADate getSettlementDate (int settlementDays, const HolidaySchedule &holidaySchedule) const
 Gets a settlement date using today as the trade date and the provided holiday schedule.
FISADate getSettlementDate (const FISADate &tradeDate, int settlementDays, const HolidaySchedule &holidaySchedule) const
 Gets a settlement date using the provided trade date and the provided holiday schedule.

Private Member Functions

FISADate getSettlementDate (time_t tradeDate, int settlementDays, const HolidaySchedule *holidaySchedule) const

Private Attributes

const HolidayScheduledefaultHolidaySchedule

Detailed Description

<deprecated>This has been deprecated. Please use BusinessDateFactory.</deprecated>


Constructor & Destructor Documentation

com::ftlabs::fisa::DefaultSettlementDateFactory::DefaultSettlementDateFactory ( void   ) 

Creates a DefaultSettlementDateFactory without a default HolidaySchedule.

com::ftlabs::fisa::DefaultSettlementDateFactory::DefaultSettlementDateFactory ( const HolidaySchedule defaultHolidaySchedule  ) 

Creates a DefaultSettlementDateFactory that utilizes the provided HolidaySchedule to determine if a date is a holiday.

Parameters:
holidays The default HolidaySchedule to use for this DefaultSettlementDateFactory.

com::ftlabs::fisa::DefaultSettlementDateFactory::DefaultSettlementDateFactory ( const DefaultSettlementDateFactory factory  ) 

virtual com::ftlabs::fisa::DefaultSettlementDateFactory::~DefaultSettlementDateFactory ( void   )  [virtual]


Member Function Documentation

DefaultSettlementDateFactory& com::ftlabs::fisa::DefaultSettlementDateFactory::operator= ( const DefaultSettlementDateFactory factory  ) 

FISADate com::ftlabs::fisa::DefaultSettlementDateFactory::getSettlementDate ( int  settlementDays  )  const [virtual]

Gets a settlement date using today as the trade date.

If a default HolidaySchedule has been set, then it will be used.

Parameters:
settlementDays The number of business days from today.
Returns:
A settlement date.

Implements com::ftlabs::fisa::SettlementDateFactory.

FISADate com::ftlabs::fisa::DefaultSettlementDateFactory::getSettlementDate ( const FISADate tradeDate,
int  settlementDays 
) const [virtual]

Gets a settlement date using the provided trade date.

If a default HolidaySchedule has been set, then it will be used.

Parameters:
tradeDate The trade date.
settlementDays The number of business days from today.
Returns:
A settlement date.

Implements com::ftlabs::fisa::SettlementDateFactory.

FISADate com::ftlabs::fisa::DefaultSettlementDateFactory::getSettlementDate ( int  settlementDays,
const HolidaySchedule holidaySchedule 
) const [virtual]

Gets a settlement date using today as the trade date and the provided holiday schedule.

If a default HolidaySchedule has been set, then both the default HolidaySchedule, and the HolidaySchedule provided to this method will be considered.

Parameters:
settlementDays The number of business days from today.
Returns:
A settlement date.

Implements com::ftlabs::fisa::SettlementDateFactory.

FISADate com::ftlabs::fisa::DefaultSettlementDateFactory::getSettlementDate ( const FISADate tradeDate,
int  settlementDays,
const HolidaySchedule holidaySchedule 
) const [virtual]

Gets a settlement date using the provided trade date and the provided holiday schedule.

If a default HolidaySchedule has been set, then both the default HolidaySchedule, and the HolidaySchedule provided to this method will be considered.

Parameters:
tradeDate The trade date.
settlementDays The number of business days from today.
Returns:
A settlement date.

Implements com::ftlabs::fisa::SettlementDateFactory.

FISADate com::ftlabs::fisa::DefaultSettlementDateFactory::getSettlementDate ( time_t  tradeDate,
int  settlementDays,
const HolidaySchedule holidaySchedule 
) const [private]


Member Data Documentation

const HolidaySchedule* com::ftlabs::fisa::DefaultSettlementDateFactory::defaultHolidaySchedule [private]


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