NormBasedCartesianConditionChecker (OREKIT 12.2 API)

java.lang.Object
- org.orekit.control.indirect.shooting.boundary.NormBasedCartesianConditionChecker

All Implemented Interfaces:

CartesianBoundaryConditionChecker
```
public class NormBasedCartesianConditionChecker
extends Object
implements CartesianBoundaryConditionChecker
```
Class defining convergence criterion on the norm of relative position and velocity vectors, with absolute tolerances.

Since:

12.2

Author:

Romain Serra

See Also:

AbstractFixedBoundaryCartesianSingleShooting

Constructor Summary

Constructors
Constructor	Description
`NormBasedCartesianConditionChecker(int maximumIterationCount, double absoluteToleranceDistance, double absoluteToleranceSpeed)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getMaximumIterationCount()`	Returns the maximum number of iterations.
`boolean`	`isConverged(PVCoordinates targetPV, PVCoordinates actualPV)`	Asserts convergence.

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

- Constructor Detail
  - NormBasedCartesianConditionChecker
```
public NormBasedCartesianConditionChecker(int maximumIterationCount,
                                          double absoluteToleranceDistance,
                                          double absoluteToleranceSpeed)
```
    Constructor.
    
    Parameters:
    
    maximumIterationCount - maximum iteration count
    
    absoluteToleranceDistance - absolute tolerance on distance
    
    absoluteToleranceSpeed - absolute tolerance on speed
- Method Detail
  - getMaximumIterationCount
```
public int getMaximumIterationCount()
```
    Returns the maximum number of iterations.
    
    Specified by:
    
    getMaximumIterationCount in interface CartesianBoundaryConditionChecker
    
    Returns:
    
    maximum iterations
  - isConverged
```
public boolean isConverged(PVCoordinates targetPV,
                           PVCoordinates actualPV)
```
    Asserts convergence.
    
    Specified by:
    
    isConverged in interface CartesianBoundaryConditionChecker
    
    Parameters:
    
    targetPV - target position-velocity
    
    actualPV - actual position-velocity
    
    Returns:
    
    convergence flag