org.orekit.files.ccsds.definitions

Enum OnOff

java.lang.Object

java.lang.Enum<OnOff>

org.orekit.files.ccsds.definitions.OnOff

All Implemented Interfaces:

Serializable, Comparable<OnOff>

public enum OnOff
extends Enum<OnOff>

On/Off status for various elements.

Since:

11.0

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF Off status.
ON On status.

Method Summary

Modifier and Type	Method and Description
boolean	isOn() Check if status is "on".
static OnOff	valueOf(String name) Returns the enum constant of this type with the specified name.
static OnOff[]	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

ON

public static final OnOff ON

On status.

OFF

public static final OnOff OFF

Off status.

Method Detail

values

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

Returns:

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

valueOf

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

isOn

public boolean isOn()

Check if status is "on".

Returns:

true if status is "on"