com.luciad.multidimensional

LuciadLightspeedEnum TLcdDimensionFilter.SnapMode

java.lang.Object

java.lang.Enum<TLcdDimensionFilter.SnapMode>

com.luciad.multidimensional.TLcdDimensionFilter.SnapMode

All Implemented Interfaces:

Serializable, Comparable<TLcdDimensionFilter.SnapMode>

Enclosing class:

TLcdDimensionFilter

public static enum TLcdDimensionFilter.SnapMode
extends Enum<TLcdDimensionFilter.SnapMode>

The snap mode to use when snapping arbitrary intervals to model intervals:

• PREVIOUS
• NEXT
• NEAREST

null indicates no snapping, in which case the model's value needs to match the filter exactly.

Since:

2016.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEAREST Snap to nearest model interval.
NEXT Snap to the next model interval.
PREVIOUS Snap to the previous model interval.

Method Summary

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

NEAREST

public static final TLcdDimensionFilter.SnapMode NEAREST

Snap to nearest model interval. For example on a time axis, this snaps to the model's nearest event in the future or the past than what the filter defines.

PREVIOUS

public static final TLcdDimensionFilter.SnapMode PREVIOUS

Snap to the previous model interval. For example on a time axis, this snaps to the most recent event which is no more recent than what the filter defines.

NEXT

public static final TLcdDimensionFilter.SnapMode NEXT

Snap to the next model interval. For example for level in the atmosphere, this snaps to the model's value at or higher than what the filter defines.

Method Detail

values

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

Returns:

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

valueOf

public static TLcdDimensionFilter.SnapMode 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