agi.foundation.numericalmethods

(agi.foundation.core-2024r2.jar)

Class JulianDateFunctionSampledEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.numericalmethods.JulianDateFunctionSampledEventArgs

public class JulianDateFunctionSampledEventArgs
extends EventArgs

Holds details of the FunctionSampled (add / remove) event.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionSampledEventArgs(JulianDateFunctionDetails function, JulianDate sampleDate, double sampleValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDateFunctionDetails	getFunction() Gets the function that was sampled.
JulianDate	getSampleDate() Gets the date at which the function was sampled.
double	getSampleValue() Gets the value that was sampled from the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

JulianDateFunctionSampledEventArgs

public JulianDateFunctionSampledEventArgs(JulianDateFunctionDetails function,
                                          @Nonnull
                                          JulianDate sampleDate,
                                          double sampleValue)

Initializes a new instance.

Parameters:

function - The function that was sampled.

sampleDate - The date at which the function was sampled.

sampleValue - The value that was sampled from the function.

Method Detail

getFunction

public final JulianDateFunctionDetails getFunction()

Gets the function that was sampled.

getSampleDate

@Nonnull
public final JulianDate getSampleDate()

Gets the date at which the function was sampled.

getSampleValue

public final double getSampleValue()

Gets the value that was sampled from the function.