Interface AttitudeProviderModifier
-
- All Superinterfaces:
AttitudeProvider
,EventDetectorsProvider
- All Known Implementing Classes:
GroundPointingAttitudeModifier
,SpinStabilized
,YawCompensation
,YawSteering
public interface AttitudeProviderModifier extends AttitudeProvider
This interface represents an attitude provider that modifies/wraps another underlying provider.- Since:
- 5.1
- Author:
- Luc Maisonobe
-
-
Field Summary
-
Fields inherited from interface org.orekit.propagation.events.EventDetectorsProvider
DATATION_ACCURACY
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Stream<EventDetector>
getEventDetectors()
Get the discrete events related to the model.default Stream<EventDetector>
getEventDetectors(List<ParameterDriver> parameterDrivers)
Get the discrete events related to the model from a list ofParameterDriver
default <T extends CalculusFieldElement<T>>
Stream<FieldEventDetector<T>>getFieldEventDetectors(Field<T> field)
Get the discrete events related to the model.default <T extends CalculusFieldElement<T>>
Stream<FieldEventDetector<T>>getFieldEventDetectors(Field<T> field, List<ParameterDriver> parameterDrivers)
Get the discrete events related to the model from a list ofParameterDriver
static AttitudeProviderModifier
getFrozenAttitudeProvider(AttitudeProvider attitudeProvider)
Wrap the input provider with a new one always returning attitudes with zero rotation rate and acceleration.AttitudeProvider
getUnderlyingAttitudeProvider()
Get the underlying attitude provider.-
Methods inherited from interface org.orekit.attitudes.AttitudeProvider
getAttitude, getAttitude, getAttitudeRotation, getAttitudeRotation
-
-
-
-
Method Detail
-
getUnderlyingAttitudeProvider
AttitudeProvider getUnderlyingAttitudeProvider()
Get the underlying attitude provider.- Returns:
- underlying attitude provider
-
getEventDetectors
default Stream<EventDetector> getEventDetectors()
Get the discrete events related to the model.This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called
- Specified by:
getEventDetectors
in interfaceAttitudeProvider
- Specified by:
getEventDetectors
in interfaceEventDetectorsProvider
- Returns:
- stream of event detectors
-
getEventDetectors
default Stream<EventDetector> getEventDetectors(List<ParameterDriver> parameterDrivers)
Get the discrete events related to the model from a list ofParameterDriver
Date detectors are used to cleanly stop the propagator and reset the state derivatives at transition dates (if any) of the parameter drivers.
This method is not intended to be called several times, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.
- Specified by:
getEventDetectors
in interfaceEventDetectorsProvider
- Parameters:
parameterDrivers
- list of parameter drivers- Returns:
- stream of event detectors
-
getFieldEventDetectors
default <T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventDetectors(Field<T> field)
Get the discrete events related to the model.This method is not intended to be called several time, only once by a propagator, as it has the side effect of rebuilding the events detectors when called
- Specified by:
getFieldEventDetectors
in interfaceAttitudeProvider
- Specified by:
getFieldEventDetectors
in interfaceEventDetectorsProvider
- Type Parameters:
T
- extends CalculusFieldElement<T>- Parameters:
field
- field to which the state belongs- Returns:
- stream of event detectors
-
getFieldEventDetectors
default <T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventDetectors(Field<T> field, List<ParameterDriver> parameterDrivers)
Get the discrete events related to the model from a list ofParameterDriver
Date detectors are used to cleanly stop the propagator and reset the state derivatives at transition dates (if any) of the parameter drivers.
This method is not intended to be called several times, only once by a propagator, as it has the side effect of rebuilding the events detectors when called.
- Specified by:
getFieldEventDetectors
in interfaceEventDetectorsProvider
- Type Parameters:
T
- extends CalculusFieldElement<T>- Parameters:
field
- field to which the state belongsparameterDrivers
- list of parameter drivers- Returns:
- stream of event detectors
-
getFrozenAttitudeProvider
static AttitudeProviderModifier getFrozenAttitudeProvider(AttitudeProvider attitudeProvider)
Wrap the input provider with a new one always returning attitudes with zero rotation rate and acceleration. It is not physically sound, but remains useful for performance when a full, physical attitude with time derivatives is not needed.- Parameters:
attitudeProvider
- provider to wrap- Returns:
- wrapping provider
- Since:
- 12.1
-
-