Package org.orekit.files.iirv

Enum IIRVMessage.IncludeMessageMetadata

java.lang.Object

java.lang.Enum<IIRVMessage.IncludeMessageMetadata>

org.orekit.files.iirv.IIRVMessage.IncludeMessageMetadata

All Implemented Interfaces:

Serializable, Comparable<IIRVMessage.IncludeMessageMetadata>

Enclosing class:

IIRVMessage

public static enum IIRVMessage.IncludeMessageMetadata
extends Enum<IIRVMessage.IncludeMessageMetadata>

Options for how message metadata appears in the IIRV message file.

Message metadata fields refer to the first four terms defined for an IIRV vector:

• MessageTypeTerm
• MessageIDTerm
• MessageSourceTerm
• MessageClassTerm

Since:

13.0

Author:

Nick LaFarge

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_VECTORS	Include message metadata fields from all vectors in a given IIRV message file.
FIRST_VECTOR_ONLY	Include message metadata fields in the first line of the first vector (when SequenceNumberTerm is 0), and omit for all other vectors in a given IIRV message file.

Method Summary

Modifier and Type	Method	Description
static IIRVMessage.IncludeMessageMetadata	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IIRVMessage.IncludeMessageMetadata[]	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

FIRST_VECTOR_ONLY

public static final IIRVMessage.IncludeMessageMetadata FIRST_VECTOR_ONLY

Include message metadata fields in the first line of the first vector (when SequenceNumberTerm is 0), and omit for all other vectors in a given IIRV message file.

ALL_VECTORS

public static final IIRVMessage.IncludeMessageMetadata ALL_VECTORS

Include message metadata fields from all vectors in a given IIRV message file.

Method Detail

values

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

Returns:

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

valueOf

public static IIRVMessage.IncludeMessageMetadata 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