PropagationEventArgs Class

Provides information about the current propagation event conditions and provides a means of indicating how the propagation should continue.

Inheritance Hierarchy

SystemObject
SystemEventArgs
AGI.Foundation.PropagatorsPropagationEventArgs

Namespace: AGI.Foundation.Propagators
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

public class PropagationEventArgs : EventArgs

Public Class PropagationEventArgs
	Inherits EventArgs

public ref class PropagationEventArgs : public EventArgs

type PropagationEventArgs =  
    class
        inherit EventArgs
    end

The PropagationEventArgs type exposes the following members.

Constructors

	Name	Description
	PropagationEventArgs	Initializes a new instance.

Properties

	Name	Description
	CurrentState	Gets the raw state at the end of the current step when this event is fired.
	CurrentTime	Gets the time at the end of the current step when this event is fired.
	Indication	Gets or sets an indication of how the propagator should continue after this event. By default, the propagation will continue, unless the event handler indicates a different condition.
	PreviousState	Gets the raw state at the beginning of the current step.
	PreviousTime	Gets the time at the beginning of the current step.
	StepSizeInformation	Gets information about the last step taken by the integrator.
	Trigger	Gets information about which method triggered this event.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StopPropagation	Sets the Indication to StopPropagationAfterStep to prevent further propagation after this step. To continue propagation after stopping it, call Propagate(Duration) again or take steps manually by calling TakeStep or Restep(Double).
	ToString	Returns a string that represents the current object. (Inherited from Object.)