PropagationStateConverterAdjustStateT Method |
Adjust a subset of the overall state to new values based on the requested element.
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public bool AdjustState<T>(
string elementID,
double[] stateToAdjust,
Motion<T> newStateValues
)
Public Function AdjustState(Of T) (
elementID As String,
stateToAdjust As Double(),
newStateValues As Motion(Of T)
) As Boolean
public:
generic<typename T>
bool AdjustState(
String^ elementID,
array<double>^ stateToAdjust,
Motion<T> newStateValues
)
member AdjustState :
elementID : string *
stateToAdjust : float[] *
newStateValues : Motion<'T> -> bool
Parameters
- elementID
- Type: SystemString
The identifier specifying which element's state values to update. - stateToAdjust
- Type: SystemDouble
The overall state to adjust. Remember that if modifying the
InitialState, the array will be a copy and needs to be reinitialized
by passing the adjusted instance of a copy to Reset(JulianDate, Double). - newStateValues
- Type: AGI.FoundationMotionT
The new state element values for the requested element.
Type Parameters
- T
- The type corresponding to the TypeOfOutput of
the requested element.
Return Value
Type:
BooleanTrue if the update was successful. Otherwise, if the specified new values did
not contain enough derivatives or there was some other problem completing the update, this returns false.
See Also