agi.foundation.numericalmethods

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

Class DurationFunctionSampledEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.numericalmethods.DurationFunctionSampledEventArgs

public class DurationFunctionSampledEventArgs
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
DurationFunctionSampledEventArgs(DurationFunctionDetails function, Duration sampleDuration, double sampleValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
DurationFunctionDetails	getFunction() Gets the function that was sampled.
Duration	getSampleDuration() Gets the duration 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

DurationFunctionSampledEventArgs

public DurationFunctionSampledEventArgs(DurationFunctionDetails function,
                                        @Nonnull
                                        Duration sampleDuration,
                                        double sampleValue)

Initializes a new instance.

Parameters:

function - The function that was sampled.

sampleDuration - The duration at which the function was sampled.

sampleValue - The value that was sampled from the function.

Method Detail

getFunction

public final DurationFunctionDetails getFunction()

Gets the function that was sampled.

getSampleDuration

@Nonnull
public final Duration getSampleDuration()

Gets the duration at which the function was sampled.

getSampleValue

public final double getSampleValue()

Gets the value that was sampled from the function.