Package org.drip.analytics.output

Class ExerciseInfo

java.lang.Object

org.drip.analytics.output.ExerciseInfo

public class ExerciseInfo
extends java.lang.Object

ExerciseInfo is a place-holder for the set of exercise information. It contains the exercise date, the exercise factor, and the exercise type. It also exposes methods to serialize/de-serialize off of byte arrays.

• Module = Product Core Module
• Library = Fixed Income Analytics
• Project = Date, Cash Flow, and Cash Flow Period Measure Generation Utilities
• Package = Period Product Targeted Valuation Measures

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor	Description
ExerciseInfo(int iDate, double dblExerciseFactor, int iWOType)	Constructs the ExerciseInfo from the work-out date, type, and the exercise factor

Method Summary

Modifier and Type	Method	Description
int	date()	Retrieve the Exercise Date
double	factor()	Retrieve the Exercise Factor
int	workoutType()	Retrieve the Work-out Type

Methods inherited from class java.lang.Object

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

Constructor Details

ExerciseInfo

public ExerciseInfo(int iDate,
double dblExerciseFactor,
int iWOType)
             throws java.lang.Exception

Constructs the ExerciseInfo from the work-out date, type, and the exercise factor

Parameters:

iDate - Work-out Date

dblExerciseFactor - Work-out Factor

iWOType - Work out Type

Throws:

java.lang.Exception - Thrown if input is invalid

Method Details

date

public int date()

Retrieve the Exercise Date

Returns:

The Exercise Date

factor

public double factor()

Retrieve the Exercise Factor

Returns:

The Exercise Factor

workoutType

public int workoutType()

Retrieve the Work-out Type

Returns:

The Work-out Type