Class EncEnvironmentSettings

java.lang.Object
com.esri.arcgisruntime.hydrography.EncEnvironmentSettings

public final class EncEnvironmentSettings extends Object
Represents settings for ENC (Electronic Navigational Chart) that are applied to all instances of EncCell and EncLayer.

A valid resource path setResourcePath(String) and a valid SENC (System Electronic Navigational Chart) data path setSencDataPath(String) are necessary to load EncCell and EncLayer.

Since:
100.2.0
  • Constructor Details Link icon

    • EncEnvironmentSettings Link icon

      public EncEnvironmentSettings()
  • Method Details Link icon

    • getDisplaySettings Link icon

      public static EncEnvironmentSettings.DisplaySettings getDisplaySettings()
      Gets the ENC display settings, which allows selection of mariner, viewing group, and text group visibility settings.
      Returns:
      the ENC display settings
      Since:
      100.2.0
    • setResourcePath Link icon

      public static void setResourcePath(String path)
      Sets the path to the directory containing the ENC resource files.
      Parameters:
      path - path to an existing directory containing the ENC resource files. If the path does not exist, then the EncCell and EncLayer will fail to load.
      Since:
      100.2.0
    • getResourcePath Link icon

      public static String getResourcePath()
      Gets the path to the directory containing the ENC resource files.
      Returns:
      the path to the directory containing the ENC resource files
      Since:
      100.2.0
    • setSencDataPath Link icon

      public static void setSencDataPath(String path)
      Sets the path to the directory where the SENC (System Electronic Navigational Chart) files will be written.

      SENC data will automatically get created the first time a EncCell is loaded. It is up to the developer to manage this data between sessions - if a map is reloaded between sessions, make sure the SENC data path is properly set to reuse the already generated SENC data.

      ENC data is converted into a SENC format for optimal chart display.

      Subsequent loads of an ENC cell will read from the SENC files directly.

      Parameters:
      path - path to an existing directory where the SENC files will be written. If the path does not exist, then the EncCell and EncLayer won't load
      Since:
      100.2.0
    • getSencDataPath Link icon

      public static String getSencDataPath()
      Gets the path to the directory where the SENC files are written.
      Returns:
      the path where SENC files will be stored, or null if none
      Since:
      100.2.0