agi.foundation.ccsds

(agi.foundation.models-2024r3.jar)

Enum CcsdsOemFileOutputFormat

java.lang.Object

java.lang.Enum<CcsdsOemFileOutputFormat>

agi.foundation.ccsds.CcsdsOemFileOutputFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CcsdsOemFileOutputFormat>

public enum CcsdsOemFileOutputFormat
extends Enum<CcsdsOemFileOutputFormat>
implements Enumeration

A value indicating which output format should be used for the CCSDS OEM file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KVN_FORMAT Key-value notation format is an ASCII text format for CCSDS OEM files.
NAMESPACE_QUALIFIED_XML_FORMAT Namespace qualified extensible markup language format is an XML format that prepends the namespace "ndm" (Navigation Data Message) to each XML node.
UNQUALIFIED_XML_FORMAT Unqualified extensible markup language format is an XML format that does not prepend a namespace to each XML node.

Method Summary

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

KVN_FORMAT

public static final CcsdsOemFileOutputFormat KVN_FORMAT

Key-value notation format is an ASCII text format for CCSDS OEM files.

UNQUALIFIED_XML_FORMAT

public static final CcsdsOemFileOutputFormat UNQUALIFIED_XML_FORMAT

Unqualified extensible markup language format is an XML format that does not prepend a namespace to each XML node.

NAMESPACE_QUALIFIED_XML_FORMAT

public static final CcsdsOemFileOutputFormat NAMESPACE_QUALIFIED_XML_FORMAT

Namespace qualified extensible markup language format is an XML format that prepends the namespace "ndm" (Navigation Data Message) to each XML node.

Method Detail

values

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

Returns:

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

valueOf

public static CcsdsOemFileOutputFormat 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 CcsdsOemFileOutputFormat 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 CcsdsOemFileOutputFormat getDefault()

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

Returns:

The default enum constant.