Module com.esri.arcgisruntime
Class EncEnvironmentSettings
java.lang.Object
com.esri.arcgisruntime.hydrography.EncEnvironmentSettings
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Represents various settings used to control display of features in allEncLayers
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the ENC display settings, which allows selection of mariner, viewing group, and text group visibility settings.static String
Gets the path to the directory containing the ENC resource files.static String
Gets the path to the directory where the SENC files are written.static void
setResourcePath
(String path) Sets the path to the directory containing the ENC resource files.static void
setSencDataPath
(String path) Sets the path to the directory where the SENC (System Electronic Navigational Chart) files will be written.
-
Constructor Details
-
Method Details
-
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
Sets the path to the directory containing the ENC resource files. -
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
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.
-
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
-