agi.foundation.stoppingconditions

(agi.foundation.models-2024r3.jar)

Class StoppingConditionEvent

java.lang.Object

agi.foundation.stoppingconditions.StoppingConditionEvent

public class StoppingConditionEvent
extends Object

The details of when a StoppingConditionEvaluator has been satisfied.

Constructor Summary

Constructors

Constructor and Description
StoppingConditionEvent(StoppingCondition condition, double value, double thresholdUsed, ITimeBasedState stateAtEvent, StoppingConditionTriggeredBehavior behavior) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
StoppingCondition	getCondition() Gets the definition of the StoppingCondition that detected the event.
JulianDate	getDateOfEvent() Gets the date of the detected event.
StoppingConditionTriggeredBehavior	getEventBehavior() Gets the behavior that the StoppablePropagator will perform having detected this event.
ITimeBasedState	getStateOfEvent() Gets the state of propagation at the time of the event.
double	getThresholdUsed() Gets the value of the threshold that the stopping condition was driving propagation too.
double	getValueOfCondition() Gets the value of the StoppingCondition detected at the event.
void	setEventBehavior(StoppingConditionTriggeredBehavior value) Sets the behavior that the StoppablePropagator will perform having detected this event.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoppingConditionEvent

public StoppingConditionEvent(StoppingCondition condition,
                              double value,
                              double thresholdUsed,
                              ITimeBasedState stateAtEvent,
                              @Nonnull
                              StoppingConditionTriggeredBehavior behavior)

Initializes a new instance.

Parameters:

condition - The identifier of the StoppingConditionEvaluator that found this event.

value - The value of the StoppingConditionEvaluator.

stateAtEvent - The state at the time of the event.

thresholdUsed - The value of the threshold that the stopping drove the event to.

behavior - Indicates how the propagator should continue given that it has detected this event.

Method Detail

getDateOfEvent

@Nonnull
public final JulianDate getDateOfEvent()

Gets the date of the detected event.

getCondition

public final StoppingCondition getCondition()

Gets the definition of the StoppingCondition that detected the event.

getValueOfCondition

public final double getValueOfCondition()

Gets the value of the StoppingCondition detected at the event. If the StoppingCondition is detecting a threshold, this should be the value of that threshold plus or minus the tolerance.

getStateOfEvent

public final ITimeBasedState getStateOfEvent()

Gets the state of propagation at the time of the event.

getEventBehavior

@Nonnull
public final StoppingConditionTriggeredBehavior getEventBehavior()

Gets the behavior that the StoppablePropagator will perform having detected this event.

setEventBehavior

public final void setEventBehavior(@Nonnull
                                   StoppingConditionTriggeredBehavior value)

Sets the behavior that the StoppablePropagator will perform having detected this event.

getThresholdUsed

public final double getThresholdUsed()

Gets the value of the threshold that the stopping condition was driving propagation too.