Click or drag to resize

PropagationStateConverterAdjustStateFromElement Method

Adjust the subset of the overall raw state corresponding to this element to new values.

Namespace:  AGI.Foundation.Propagators
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
Copy
public bool AdjustStateFromElement(
	string elementID,
	double[] overallRawState,
	Motion<double[]> stateElementValues
)

Parameters

elementID
Type: SystemString
The string identifying which propagation state element to use when converting the raw state. (AuxiliaryStateElementConverter does not output its element as a Motion of double arrays, so auxiliary state element IDs are not supported.)
overallRawState
Type: SystemDouble
The overall raw state to adjust.
stateElementValues
Type: AGI.FoundationMotionDouble
The new values and derivatives for the requested element represented as an array. To obtain an instance of this array, call GetElementFromState(String, Double).

Return Value

Type: Boolean
True if the update was successful. Otherwise, if the specified new element values did not contain enough derivatives or there was some other problem completing the update, this returns false.
See Also