com::ftlabs::fisa::InterestFrequency

com::ftlabs::fisa::InterestFrequency Class Reference

This class defines all of the supported interest frequencies. More...

#include <InterestFrequency.h>

List of all members.

Public Member Functions

const std::string & getName (void) const
 Get the name of this InterestFrequency.
int getValue (void) const
 Get the number of periods per year.

Static Public Member Functions

static const InterestFrequency * getByValue (int value)
 Get a pointer to an InterestFrequency for the given value ( periods per year ).

Static Public Attributes

static InterestFrequency ANNUAL
 Static Annual InterestFrequency ( 1 ).
static InterestFrequency SEMI_ANNUAL
 Static Semi Annual InterestFrequency ( 2 ).
static InterestFrequency QUARTERLY
 Static Quarterly InterestFrequency ( 4 ).
static InterestFrequency MONTHLY
 Static Quarterly InterestFrequency ( 12 ).

Private Member Functions

 InterestFrequency (const std::string &name, int value)
 ~InterestFrequency (void)

Private Attributes

std::string name
int value

Detailed Description

This class defines all of the supported interest frequencies.

Constructor & Destructor Documentation

com::ftlabs::fisa::InterestFrequency::InterestFrequency ( const std::string &  name,
int  value 
) [private]

com::ftlabs::fisa::InterestFrequency::~InterestFrequency ( void   )  [private]

Member Function Documentation

static const InterestFrequency* com::ftlabs::fisa::InterestFrequency::getByValue ( int  value  )  [static]

Get a pointer to an InterestFrequency for the given value ( periods per year ).

The pointer returned references one of the static instances managed by InterestFrequency and must not be deleted.

Parameters:
value the number of periods per year.

Returns:
a pointer to an InterestFrequency object for the given value, or null if the value is unsupported.

const std::string& com::ftlabs::fisa::InterestFrequency::getName ( void   )  const

Get the name of this InterestFrequency.

Returns:
the name of this InterestFrequency.

int com::ftlabs::fisa::InterestFrequency::getValue ( void   )  const

Get the number of periods per year.

Returns:
the number of periods per year.

Member Data Documentation

InterestFrequency com::ftlabs::fisa::InterestFrequency::ANNUAL [static]

Static Annual InterestFrequency ( 1 ).

InterestFrequency com::ftlabs::fisa::InterestFrequency::SEMI_ANNUAL [static]

Static Semi Annual InterestFrequency ( 2 ).

InterestFrequency com::ftlabs::fisa::InterestFrequency::QUARTERLY [static]

Static Quarterly InterestFrequency ( 4 ).

InterestFrequency com::ftlabs::fisa::InterestFrequency::MONTHLY [static]

Static Quarterly InterestFrequency ( 12 ).

std::string com::ftlabs::fisa::InterestFrequency::name [private]

int com::ftlabs::fisa::InterestFrequency::value [private]

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