com::ftlabs::fisa::AbstractSecurity Class Reference

Abstract Security implementation with very minimum common fields. More...

#include <AbstractSecurity.h>

Inheritance diagram for com::ftlabs::fisa::AbstractSecurity:

com::ftlabs::fisa::Security com::ftlabs::fisa::MaturingSecurity com::ftlabs::fisa::DiscountSecurity com::ftlabs::fisa::MaturingCallableSecurity 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

const MarketgetMarket (void) const
 Get the Market for this Security.
const FISADategetDatedDate (void) const
 Get the DatedDate set for this Security.
void setDatedDate (const FISADate *datedDate)
 Set the DatedDate for this Security.
double getParValue (void) const
 Get the parValue.
void setParValue (double parValue)
 Set the parValue.
const DayCountBasisgetDayCountBasis (void) const
 Get the DayCountBasis.
void setDayCountBasis (const DayCountBasis &dayCountBasis)
 Set the DayCountBasis.
bool isEomAdjust (void) const
 Get the EOM Adjust flag, which determines whether the End Of Month Adjustment rule should be used while calculating days for this Security.
void setEomAdjust (bool eomAdjust)
 Set the EOM Adjust flag, which determines whether the End Of Month Adjustment rule should be used while calculating days for this Security.

Protected Member Functions

 AbstractSecurity (const Market &market, const Security::ClassID &classID)
 AbstractSecurity (const AbstractSecurity &security)
AbstractSecurityoperator= (const AbstractSecurity &security)
virtual ~AbstractSecurity (void)

Private Attributes

const Marketmarket
const FISADatedatedDate
double parValue
const DayCountBasisdayCountBasis
bool eomAdjust

Detailed Description

Abstract Security implementation with very minimum common fields.


Constructor & Destructor Documentation

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

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

virtual com::ftlabs::fisa::AbstractSecurity::~AbstractSecurity ( void   )  [protected, virtual]


Member Function Documentation

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

const Market& com::ftlabs::fisa::AbstractSecurity::getMarket ( void   )  const [virtual]

Get the Market for this Security.

Returns:
The Market for this Security.

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

const FISADate* com::ftlabs::fisa::AbstractSecurity::getDatedDate ( void   )  const

Get the DatedDate set for this Security.

Returns:
The DatedDate set for this Security, or 0 if none has been set.

void com::ftlabs::fisa::AbstractSecurity::setDatedDate ( const FISADate datedDate  ) 

Set the DatedDate for this Security.

Parameters:
datedDate A pointer to the new DatedDate, or 0 it none should be set. If datedDate != 0, a copy is made of the FISADate referenced by datedDate. Otherwise the datedDate is set to 0.

double com::ftlabs::fisa::AbstractSecurity::getParValue ( void   )  const

Get the parValue.

Returns:
The parValue.

void com::ftlabs::fisa::AbstractSecurity::setParValue ( double  parValue  ) 

Set the parValue.

Parameters:
parValue The parValue.

const DayCountBasis& com::ftlabs::fisa::AbstractSecurity::getDayCountBasis ( void   )  const

Get the DayCountBasis.

Returns:
The DayCountBasis.

void com::ftlabs::fisa::AbstractSecurity::setDayCountBasis ( const DayCountBasis dayCountBasis  ) 

Set the DayCountBasis.

Parameters:
dayCountBasis The DayCountBasis.

bool com::ftlabs::fisa::AbstractSecurity::isEomAdjust ( void   )  const

Get the EOM Adjust flag, which determines whether the End Of Month Adjustment rule should be used while calculating days for this Security.

Returns:
true if the EOM Adjust rule should be used for this Security, otherwise false.

void com::ftlabs::fisa::AbstractSecurity::setEomAdjust ( bool  eomAdjust  ) 

Set the EOM Adjust flag, which determines whether the End Of Month Adjustment rule should be used while calculating days for this Security.

Parameters:
eomAdjust The new eomAdjust setting.


Member Data Documentation

const Market* com::ftlabs::fisa::AbstractSecurity::market [private]

const FISADate* com::ftlabs::fisa::AbstractSecurity::datedDate [private]

double com::ftlabs::fisa::AbstractSecurity::parValue [private]

const DayCountBasis* com::ftlabs::fisa::AbstractSecurity::dayCountBasis [private]

bool com::ftlabs::fisa::AbstractSecurity::eomAdjust [private]


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