Skip To Content ArcGIS for Developers Sign In Dashboard

EncEnvironmentSettings Class

(Esri::ArcGISRuntime::EncEnvironmentSettings)

An Electronic Navigation Chart (ENC) environment settings object. More...

Header: #include <EncEnvironmentSettings>
Since: Esri::ArcGISRuntime 100.2
Inherits: Object

Public Functions

  • 31 public functions inherited from QObject

Static Public Members

EncDisplaySettings *displaySettings()
EncEnvironmentSettings *instance()
QString resourcePath()
QString sencDataPath()
void setResourcePath(const QString &path)
void setSencDataPath(const QString &path)
  • 10 static public members inherited from QObject

Additional Inherited Members

Detailed Description

An Electronic Navigation Chart (ENC) environment settings object.

Uses this singleton class to access to ENC display settings, to set paths to your local files, and to connect to errorOccurred signal.

// get EncDisplaySettings instance
EncDisplaySettings* displaySettings = EncEnvironmentSettings::displaySettings();

// set paths
EncEnvironmentSettings::setSencDataPath(sencDataPath);
EncEnvironmentSettings::setResourcePath(resourcePath);

Note: You cannot create an object of this class. Rather, an instance is automatically created and only that single instance is available for use in the app.

See also EncLayer.

Member Function Documentation

EncEnvironmentSettings::~EncEnvironmentSettings()

Destructor.

[static] EncDisplaySettings *EncEnvironmentSettings::displaySettings()

Gets the S52 display properties for the environment.

[static] EncEnvironmentSettings *EncEnvironmentSettings::instance()

Returns the singleton instance of the ENC environment settings.

Use this method to get a reference to this instance so you can connect its signals to slots.

[static] QString EncEnvironmentSettings::resourcePath()

Gets the path to the ENC resource files.

You would rarely need to set this, as the build process will auto-deploy these resources in the correct default location, and should only be set if you want to override/update these resource, or share them across multiple apps.

In desktop platforms, the default path is the runtime install path, defined in ArcGISRuntimeEnvironment.installPath. In mobile platforms, the default path is the application deployment path.

See also setResourcePath() and ArcGISRuntimeEnvironment.

[static] QString EncEnvironmentSettings::sencDataPath()

Gets the path to the SENC resource files.

The default path is the system's temporary path.

Note: It is up to the developer to maintain this data between sessions. If a path is not explicitly set, the Runtime temp path will be used.

See also setSencDataPath().

[static] void EncEnvironmentSettings::setResourcePath(const QString &path)

Sets the path to the ENC resource files.

  • path - The path to the ENC resource files.

Note: The resources path must be set before ENC content can be used (regardless of whether that use involves content display).

See also resourcePath().

[static] void EncEnvironmentSettings::setSencDataPath(const QString &path)

Sets the path to the SENC resource files to path.

SENC is an acronym for System Electronic Navigational Chart. ENC data is converted into an internal SENC format for optimal chart display.

Note: Subsequent loads of an ENC cell or exchange set will ignore the underlying cells (.000 files). Runtime will instead read from the internal SENC files directly.

Note: It is up to the developer to maintain this data between sessions. If a path is not explicitly set, the Runtime temp path will be used.

See also sencDataPath().


Feedback on this topic?