ActActDCParams

java.lang.Object

org.drip.analytics.daycount.ActActDCParams

public class ActActDCParams
extends java.lang.Object

ActActDCParams contains parameters to represent Act/Act day count. It exports the following functionality:

Frequency/Start/End Date Fields
Serialization/De-serialization to and from Byte Arrays

Module = Product Core Module
Library = Fixed Income Analytics
Project = Date, Cash Flow, and Cash Flow Period Measure Generation Utilities
Package = Day Count Year Fraction Utilities

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

ActActDCParams(int iFreq, int iNumDays)
Constructs an ActActDCParams instance from the corresponding parameters

Method Summary

Modifier and Type	Method	Description
`int`	`days()`	Number of Days in the Act/Act Period
`int`	`freq()`	Retrieve the Frequency
`static ActActDCParams`	`FromFrequency(int iFreq)`	Construct an ActActDCParams from the specified Frequency

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ActActDCParams
  
  public ActActDCParams(int iFreq, int iNumDays) throws java.lang.Exception
  
  Constructs an ActActDCParams instance from the corresponding parameters
  
  Parameters:
  
  iFreq - Frequency
  
  iNumDays - Number of Days in the Period
  
  Throws:
  
  java.lang.Exception - Thrown if inputs are invalid
Method Details
- FromFrequency
  
  public static final ActActDCParams FromFrequency(int iFreq)
  
  Construct an ActActDCParams from the specified Frequency
  
  Parameters:
  
  iFreq - The Frequency
  
  Returns:
  
  The ActActDCParams Instance
- freq
  
  public int freq()
  
  Retrieve the Frequency
  
  Returns:
  
  The Frequency
- days
  
  public int days()
  
  Number of Days in the Act/Act Period
  
  Returns:
  
  The Number of Days in the Act/Act Period