com.luciad.util

LuciadLightspeedEnum TLcdColorMap.LevelInclusion

java.lang.Object

java.lang.Enum<TLcdColorMap.LevelInclusion>

com.luciad.util.TLcdColorMap.LevelInclusion

All Implemented Interfaces:

Serializable, Comparable<TLcdColorMap.LevelInclusion>

Enclosing class:

TLcdColorMap

public static enum TLcdColorMap.LevelInclusion
extends Enum<TLcdColorMap.LevelInclusion>

The LevelInclusion determines how the levels are interpreted when retrieving values using TLcdColorMap.retrieveColor(double).

Since:

2019.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDES_END_POINT Level inclusion which excludes the end point.
INCLUDES_END_POINT Level inclusion which includes the end point.

Method Summary

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

INCLUDES_END_POINT

public static final TLcdColorMap.LevelInclusion INCLUDES_END_POINT

Level inclusion which includes the end point. The color of that point will be the color of the current level.

Using {100, 200, 300} as levels and {Black, Green, Blue, Red} as colors (piecewise constant), the intervals would be defined as follows:

• ]-inf, 100] - Black
• ]100, 200] - Green
• ]200, 300] - Blue
• ]300, +inf[ - Red

EXCLUDES_END_POINT

public static final TLcdColorMap.LevelInclusion EXCLUDES_END_POINT

Level inclusion which excludes the end point. The color of that point will be the color of the next level.

Using {100, 200, 300} as levels and {Black, Green, Blue, Red} as colors (piecewise constant), the intervals would be defined as follows:

• ]-inf, 100[ - Black
• [100, 200[ - Green
• [200, 300[ - Blue
• [300, +inf[ - Red

Method Detail

values

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

Returns:

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

valueOf

public static TLcdColorMap.LevelInclusion 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