org.orekit.estimation.measurements.generation

Enum SignSemantic

java.lang.Object

java.lang.Enum<SignSemantic>

org.orekit.estimation.measurements.generation.SignSemantic

All Implemented Interfaces:

Serializable, Comparable<SignSemantic>

public enum SignSemantic
extends Enum<SignSemantic>

Enumerate for the semantic of the g function sign during measurements generation.

Since:

9.3

Author:

Luc Maisonobe

See Also:

EventBasedScheduler

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEASIBLE_MEASUREMENT_WHEN_NEGATIVE Semantic for detectors that have negative g function when measurements are feasible.
FEASIBLE_MEASUREMENT_WHEN_POSITIVE Semantic for detectors that have positive g function when measurements are feasible.

Method Summary

Modifier and Type	Method and Description
boolean	measurementIsFeasible(double g) Check if measurement is feasible.
static SignSemantic	valueOf(String name) Returns the enum constant of this type with the specified name.
static SignSemantic[]	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

FEASIBLE_MEASUREMENT_WHEN_POSITIVE

public static final SignSemantic FEASIBLE_MEASUREMENT_WHEN_POSITIVE

Semantic for detectors that have positive g function when measurements are feasible.

FEASIBLE_MEASUREMENT_WHEN_NEGATIVE

public static final SignSemantic FEASIBLE_MEASUREMENT_WHEN_NEGATIVE

Semantic for detectors that have negative g function when measurements are feasible.

Method Detail

values

public static SignSemantic[] 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 (SignSemantic c : SignSemantic.values())
    System.out.println(c);

Returns:

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

valueOf

public static SignSemantic 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

measurementIsFeasible

public boolean measurementIsFeasible(double g)

Check if measurement is feasible.

Parameters:

g - value of the detector g function

Returns:

true if measurement is feasible