com.luciad.format.s57

Maritime StandardsEnum ELcdS57ProductType

java.lang.Object

java.lang.Enum<ELcdS57ProductType>

com.luciad.format.s57.ELcdS57ProductType

All Implemented Interfaces:

Serializable, Comparable<ELcdS57ProductType>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and 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 type with the specified name.
static ELcdS57ProductType[]	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

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 Detail

values

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

Returns:

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

valueOf

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

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