fr.cnes.sirius.patrius.events.detectors

Enum SurfaceDistanceDetector.BodyDistanceType

java.lang.Object

java.lang.Enum<SurfaceDistanceDetector.BodyDistanceType>

fr.cnes.sirius.patrius.events.detectors.SurfaceDistanceDetector.BodyDistanceType

All Implemented Interfaces:

Serializable, Comparable<SurfaceDistanceDetector.BodyDistanceType>

Enclosing class:

SurfaceDistanceDetector

public static enum SurfaceDistanceDetector.BodyDistanceType
extends Enum<SurfaceDistanceDetector.BodyDistanceType>

Body distance type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSEST Distance to the closest point of the body surface.
RADIAL Distance from the closest point of the body surface aligned with the spacecraft and the body center.

Method Summary

Modifier and Type	Method and Description
abstract double	getDistance(BodyPoint point) Getter for the distance to the given point.
static SurfaceDistanceDetector.BodyDistanceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SurfaceDistanceDetector.BodyDistanceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLOSEST

public static final SurfaceDistanceDetector.BodyDistanceType CLOSEST

Distance to the closest point of the body surface.

RADIAL

public static final SurfaceDistanceDetector.BodyDistanceType RADIAL

Distance from the closest point of the body surface aligned with the spacecraft and the body center.

Method Detail

values

public static SurfaceDistanceDetector.BodyDistanceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SurfaceDistanceDetector.BodyDistanceType c : SurfaceDistanceDetector.BodyDistanceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SurfaceDistanceDetector.BodyDistanceType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDistance

public abstract double getDistance(BodyPoint point)

Getter for the distance to the given point.

Parameters:

point - Point

Returns:

the distance to the point