StoppablePropagatorGetInitialState Method

Creates the initial state from the wrapped propagator. Normal use cases will have the initial state passed into the PropagateUntilStop(ITimeBasedState, IEnumerableStoppingConditionEvaluator, IntegrationSense, Boolean, Int32, ITrackCalculationProgress) method. However should the propagator be configured to have an initial state it should be returned here.

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

Syntax

C++

Copy

public virtual ITimeBasedState GetInitialState(
	IntegrationSense direction
)

Public Overridable Function GetInitialState ( 
	direction As IntegrationSense
) As ITimeBasedState

public:
virtual ITimeBasedState^ GetInitialState(
	IntegrationSense direction
)

abstract GetInitialState : 
        direction : IntegrationSense -> ITimeBasedState 
override GetInitialState : 
        direction : IntegrationSense -> ITimeBasedState

Parameters

direction: Type: AGI.Foundation.NumericalMethodsIntegrationSense
Which direction the propagation is going.

Return Value

Type: ITimeBasedState
, or the initial state of the wrapped propagator as initially configured.

Reference

StoppablePropagator Class

AGI.Foundation.Propagators Namespace

StoppablePropagatorAddLanguageSpecificTextSet("LSTC626B857_0?cpp=::|nu=.");GetInitialState Method

Parameters

Return Value

Reference

StoppablePropagatorGetInitialState Method