agi.foundation.ccsds

(agi.foundation.models-2023r2.jar)

Enum CcsdsReferenceFrameType

java.lang.Object

java.lang.Enum<CcsdsReferenceFrameType>

agi.foundation.ccsds.CcsdsReferenceFrameType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CcsdsReferenceFrameType>

public enum CcsdsReferenceFrameType
extends Enum<CcsdsReferenceFrameType>
implements Enumeration

This type defines whether a Consultative Committee for Space Data Systems (CCSDS) reference frame is inertial, fixed, or unknown.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED The reference frame of the CCSDS data has been inferred to be a fixed frame.
INERTIAL The reference frame of the CCSDS data has been inferred to be an inertial frame.
UNKNOWN The reference frame type cannot be easily inferred from the available CCSDS data, or an attempt to infer the reference frame has not been performed yet.

Method Summary

Modifier and Type	Method and Description
static CcsdsReferenceFrameType	getDefault() Get the enum constant that is considered to be the default.
static CcsdsReferenceFrameType	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CcsdsReferenceFrameType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CcsdsReferenceFrameType[]	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

UNKNOWN

public static final CcsdsReferenceFrameType UNKNOWN

The reference frame type cannot be easily inferred from the available CCSDS data, or an attempt to infer the reference frame has not been performed yet.

INERTIAL

public static final CcsdsReferenceFrameType INERTIAL

The reference frame of the CCSDS data has been inferred to be an inertial frame.

FIXED

public static final CcsdsReferenceFrameType FIXED

The reference frame of the CCSDS data has been inferred to be a fixed frame.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CcsdsReferenceFrameType getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CcsdsReferenceFrameType getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.