agi.foundation.propagators

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

Class StoppablePropagatorStepTakenArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.propagators.StoppablePropagatorStepTakenArgs

public class StoppablePropagatorStepTakenArgs
extends EventArgs

The data for the event that gets raised when a StoppablePropagator takes a step or resteps.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
StoppablePropagatorStepTakenArgs(ITimeBasedState previousState, ITimeBasedState currentState, PropagationEventTrigger eventTrigger) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
ITimeBasedState	getCurrentState() Gets the current state of propagation.
ITimeBasedState	getPreviousState() Gets the previous state of propagation.
PropagationEventTrigger	getTrigger() Gets information about which method triggered this event.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoppablePropagatorStepTakenArgs

public StoppablePropagatorStepTakenArgs(ITimeBasedState previousState,
                                        ITimeBasedState currentState,
                                        @Nonnull
                                        PropagationEventTrigger eventTrigger)

Initializes a new instance.

Parameters:

previousState - The previously propagated state.

currentState - The current propagated state.

eventTrigger - If this step was a normal step or a restep.

Method Detail

getPreviousState

public final ITimeBasedState getPreviousState()

Gets the previous state of propagation.

getCurrentState

public final ITimeBasedState getCurrentState()

Gets the current state of propagation.

getTrigger

@Nonnull
public final PropagationEventTrigger getTrigger()

Gets information about which method triggered this event.