Module org.yamcs.xtce

Package org.yamcs.xtce

Enum Class ParameterInstanceRef.InstanceRelativeTo

java.lang.Object

java.lang.Enum<ParameterInstanceRef.InstanceRelativeTo>

org.yamcs.xtce.ParameterInstanceRef.InstanceRelativeTo

All Implemented Interfaces:

Serializable, Comparable<ParameterInstanceRef.InstanceRelativeTo>, Constable

Enclosing class:

ParameterInstanceRef

public static enum ParameterInstanceRef.InstanceRelativeTo
extends Enum<ParameterInstanceRef.InstanceRelativeTo>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT_ENTRY_ACROSS_PACKETS	This is the same as CURRENT_ENTRY_WITHIN_PACKET but not restricted to the current packet.
CURRENT_ENTRY_WITHIN_PACKET	The instance field counts negatively from the current entry. 0 means the last instance.
PACKET_START_ACROSS_PACKETS	The instance field counts positively from the beginning of the packet.
PACKET_START_WITHIN_PACKET	The instance field counts positively from the beginning of the packet.

Method Summary

Modifier and Type	Method	Description
static ParameterInstanceRef.InstanceRelativeTo	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParameterInstanceRef.InstanceRelativeTo[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PACKET_START_WITHIN_PACKET

public static final ParameterInstanceRef.InstanceRelativeTo PACKET_START_WITHIN_PACKET

The instance field counts positively from the beginning of the packet.

Negative values are not allowed.

PACKET_START_ACROSS_PACKETS

public static final ParameterInstanceRef.InstanceRelativeTo PACKET_START_ACROSS_PACKETS

The instance field counts positively from the beginning of the packet.

Negative values means previously received data (with the possibility of missing packets, which may result in retrieving older values than intended)

CURRENT_ENTRY_WITHIN_PACKET

public static final ParameterInstanceRef.InstanceRelativeTo CURRENT_ENTRY_WITHIN_PACKET

The instance field counts negatively from the current entry. 0 means the last instance. Strictly positive values are not allowed.

The lookup stops in the current packet, values from previous packets are not considered.

CURRENT_ENTRY_ACROSS_PACKETS

public static final ParameterInstanceRef.InstanceRelativeTo CURRENT_ENTRY_ACROSS_PACKETS

This is the same as CURRENT_ENTRY_WITHIN_PACKET but not restricted to the current packet.

The lookup continues to the previous packets (with the possibility of missing packets, which may result in retrieving older values than intended).

Method Details

values

public static ParameterInstanceRef.InstanceRelativeTo[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ParameterInstanceRef.InstanceRelativeTo valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null