Package com.luciad.format.s57

Enum Class ELcdS57ProductType

java.lang.Object

java.lang.Enum<ELcdS57ProductType>

com.luciad.format.s57.ELcdS57ProductType

All Implemented Interfaces:

Serializable, Comparable<ELcdS57ProductType>, Constable

public enum ELcdS57ProductType
extends Enum<ELcdS57ProductType>

Enumeration modeling the S-57 product types supported out-of-the-box by the Maritime Standards component.

Since:

11.0

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
AML	The AML (Additional Military Layers) product type.
ENC	The ENC (Electronic Navigational Charts) product type.
IENC	The IENC (Inland ENC) product type.

Method Summary

Modifier and Type	Method	Description
static ELcdS57ProductType	fromModel(ILcdModel aModel)	Returns the S-57 product type of the given model.
String	getConfigurationSourceName()	Returns the source filename of the product configuration file.
String	getName()
static ELcdS57ProductType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ELcdS57ProductType[]	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

ENC

public static final ELcdS57ProductType ENC

The ENC (Electronic Navigational Charts) product type.

IENC

public static final ELcdS57ProductType IENC

The IENC (Inland ENC) product type.

AML

public static final ELcdS57ProductType AML

The AML (Additional Military Layers) product type.

Method Details

values

public static ELcdS57ProductType[] 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 ELcdS57ProductType 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

getConfigurationSourceName

public String getConfigurationSourceName()

Returns the source filename of the product configuration file.

Returns:

the source filename of the product configuration file.

getName

public String getName()

fromModel

public static ELcdS57ProductType fromModel(ILcdModel aModel)

Returns the S-57 product type of the given model.

Parameters:

aModel - the model to check. Can be a cell or catalogue.

Returns:

the used product type, or null if the model does not contain ECDIS related data.

Since:

2023.0