YZPlaneCrossingDetector (Orekit Tutorials 12.1-SNAPSHOT API)

java.lang.Object
- org.orekit.propagation.events.AbstractDetector<YZPlaneCrossingDetector>
- - org.orekit.tutorials.propagation.cr3bp.YZPlaneCrossingDetector

All Implemented Interfaces:

org.orekit.propagation.events.EventDetector
```
public class YZPlaneCrossingDetector
extends org.orekit.propagation.events.AbstractDetector<YZPlaneCrossingDetector>
```
Detector for YZ Planes crossing.

Since:

10.2

Author:

Vincent Mouraux

Field Summary
- Fields inherited from class org.orekit.propagation.events.AbstractDetector
  DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors
Constructor Description

YZPlaneCrossingDetector(double delta, double maxCheck, double threshold)
Simple Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected YZPlaneCrossingDetector`	`create(org.orekit.propagation.events.AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, org.orekit.propagation.events.handlers.EventHandler newHandler)`
`double`	`g(org.orekit.propagation.SpacecraftState s)`	Compute the value of the detection function.

Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold

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

- Constructor Detail
  - YZPlaneCrossingDetector
```
public YZPlaneCrossingDetector(double delta,
                               double maxCheck,
                               double threshold)
```
    Simple Constructor.
    
    Parameters:
    
    delta - Offset from X=0 plane;
    
    maxCheck - maximum checking interval (s)
    
    threshold - convergence threshold (s)
- Method Detail
  - create
```
protected YZPlaneCrossingDetector create(org.orekit.propagation.events.AdaptableInterval newMaxCheck,
                                         double newThreshold,
                                         int newMaxIter,
                                         org.orekit.propagation.events.handlers.EventHandler newHandler)
```
    Specified by:
    
    create in class org.orekit.propagation.events.AbstractDetector<YZPlaneCrossingDetector>
  - g
```
public double g(org.orekit.propagation.SpacecraftState s)
```
    Compute the value of the detection function.
    
    Specified by:
    
    g in interface org.orekit.propagation.events.EventDetector
    
    Specified by:
    
    g in class org.orekit.propagation.events.AbstractDetector<YZPlaneCrossingDetector>
    
    Parameters:
    
    s - the current state information: date, kinematics, attitude
    
    Returns:
    
    Difference between spacecraft X position and the targeted plane offset from zero