FieldAbstractCartesianCost.FieldSwitchFunction (OREKIT 14.0-SNAPSHOT API)

java.lang.Object
- org.orekit.control.indirect.adjoint.cost.FieldAbstractCartesianCost.FieldSwitchFunction

All Implemented Interfaces:

EventFunction, EventFunctionModifier

Enclosing class:

FieldAbstractCartesianCost<T extends CalculusFieldElement<T>>
```
public class FieldAbstractCartesianCost.FieldSwitchFunction
extends Object
implements EventFunctionModifier
```
Class for control switch function involving Field.

Constructor Summary

Constructors
Modifier Constructor Description

protected FieldSwitchFunction(Function<FieldSpacecraftState<T>,T> fieldFunction)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`dependsOnMainVariablesOnly()`	Method returning true if and only if the event function does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates).
`EventFunction`	`getBaseFunction()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.events.functions.EventFunctionModifier
dependsOnTimeOnly, value, value

- Constructor Detail
  - FieldSwitchFunction
```
protected FieldSwitchFunction(Function<FieldSpacecraftState<T>,T> fieldFunction)
```
- Method Detail
  - getBaseFunction
```
public EventFunction getBaseFunction()
```
    Specified by:
    
    getBaseFunction in interface EventFunctionModifier
  - dependsOnMainVariablesOnly
```
public boolean dependsOnMainVariablesOnly()
```
    Description copied from interface: EventFunction
    
    Method returning true if and only if the event function does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates). It should thus return false if the STM is needed to evaluate the event. This information is used for performance in propagation.
    
    Specified by:
    
    dependsOnMainVariablesOnly in interface EventFunction
    
    Specified by:
    
    dependsOnMainVariablesOnly in interface EventFunctionModifier
    
    Returns:
    
    flag