Skip To Content ArcGIS for Developers Sign In Dashboard

EncMarinerSettings Class

(Esri::ArcGISRuntime::EncMarinerSettings)

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

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

Public Functions

~EncMarinerSettings()
EncAreaSymbolizationType areaSymbolizationType() const
EncColorScheme colorScheme() const
double deepContour() const
EncDisplayCategories *displayCategories() const
EncDisplayDepthUnits displayDepthUnits() const
bool isDataQuality() const
bool isDisplayNobjnm() const
bool isHonorScamin() const
bool isIsolatedDangers() const
bool isLabelContours() const
bool isLabelSafetyContours() const
bool isLowAccuracy() const
bool isShallowDepthPattern() const
bool isTwoDepthShades() const
EncPointSymbolizationType pointSymbolizationType() const
void resetToDefaults()
double safetyContour() const
void setAreaSymbolizationType(EncAreaSymbolizationType type)
void setColorScheme(EncColorScheme scheme)
void setDataQuality(bool value)
void setDeepContour(double meters)
void setDisplayDepthUnits(EncDisplayDepthUnits displayDepthUnits)
void setDisplayNobjnm(bool value)
void setHonorScamin(bool value)
void setIsolatedDangers(bool value)
void setLabelContours(bool value)
void setLabelSafetyContours(bool value)
void setLowAccuracy(bool value)
void setPointSymbolizationType(EncPointSymbolizationType type)
void setSafetyContour(double meters)
void setShallowContour(double meters)
void setShallowDepthPattern(bool value)
void setTwoDepthShades(bool value)
double shallowContour() const
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

An Electronic Navigation Chart (ENC) mariner settings object.

// get EncMarinerSettings instance
EncMarinerSettings* encMarinerSettings = EncEnvironmentSettings::displaySettings()->marinerSettings();

// set properties
encMarinerSettings->setDeepContour(true);
encMarinerSettings->setLabelContours(true);

Note: You cannot create an object of this class. Use EncDisplaySettings to get an instance.

See also EncLayer.

Member Function Documentation

EncMarinerSettings::~EncMarinerSettings()

Destructor.

EncAreaSymbolizationType EncMarinerSettings::areaSymbolizationType() const

Gets the type of area symbolization.

This controls the line symbol style for areas.

The default value is Symbolized.

Note: "Symbolized" area symbolization renders area symbols using the traditional paper chart symbology. Plain reduces clutter.

See also setAreaSymbolizationType().

EncColorScheme EncMarinerSettings::colorScheme() const

Gets the color scheme.

The S52 standard allows for switching between three color modes: Day, Dusk and Night.

The default value is Day.

Note: This affects the color scheme used on all layers in the map.

See also setColorScheme().

double EncMarinerSettings::deepContour() const

Gets the deep contour depth in meters.

When four (rather than two) depth shades are used, this controls the boundary between safe and deep areas.

The default value is 30 (meters).

See also setDeepContour().

EncDisplayCategories *EncMarinerSettings::displayCategories() const

Returns the S-52 display category (base/standard/other).

The actual status for individual objects within a category may be inconsistent with the setting for the category.

The default is that all three categories are enabled.

EncDisplayDepthUnits EncMarinerSettings::displayDepthUnits() const

Gets the depth units for soundings and contours for display.

The default value is meters.

See also setDisplayDepthUnits().

bool EncMarinerSettings::isDataQuality() const

Returns whether to the display the quality of data.

The default value is false, meaning that quality of data will not be displayed.

bool EncMarinerSettings::isDisplayNobjnm() const

Returns whether to display the national names.

This is text group 31 per IHO S-52 Annex A.

The default value is true, meaning national names will be displayed.

bool EncMarinerSettings::isHonorScamin() const

Returns whether the SCAMIN (scale min) S-57 feature attribute will be honored.

If disabled, all ENC features will be rendered regardless of scale.

The default value is true, meaning the 'SCAMIN' attribute will be honored.

bool EncMarinerSettings::isIsolatedDangers() const

Returns whether to display the isolated dangers in shallow water.

The default value is false, meaning isolated dangers will not be shown in shallow water.

bool EncMarinerSettings::isLabelContours() const

Returns whether to display the depth contour labels, including the safety contour label.

This is viewing group 33021, 33022 per IHO S-52 Annex A.

The default value is true, meaning the depth contour labels will be displayed.

bool EncMarinerSettings::isLabelSafetyContours() const

Returns whether to display the safety contour labels.

The default value is true, meaning the safety contour labels will be displayed.

bool EncMarinerSettings::isLowAccuracy() const

Returns whether to use low accuracy symbols.

This is viewing group 31010 per IHO S-52 Annex A.

The default value is true, meaning vectors marked as 'low accuracy data' will be symbolized differently.

When set to false, low accuracy data will be visually indistinguishable from other data.

bool EncMarinerSettings::isShallowDepthPattern() const

Returns whether to symbolize the shallow depth pattern.

The default value is false, meaning the shallow depth pattern will not be symbolized.

bool EncMarinerSettings::isTwoDepthShades() const

Returns whether to display the two depth shades.

The default value is true, meaning two rather than four depth shades will be used.

EncPointSymbolizationType EncMarinerSettings::pointSymbolizationType() const

Gets the point feature symbolization type.

This is used to specify whether point features should be symbolized with simplified or paperchart symbols.

Paperchart symbolization is based on traditional paper charts. Simplified symbols are more compact and visible.

The default value is paperchart.

See also setPointSymbolizationType().

void EncMarinerSettings::resetToDefaults()

Resets all S52 display properties to their default settings.

double EncMarinerSettings::safetyContour() const

Gets the depth of the safety contour in meters.

The safety contour separates safe from unsafe areas.

The default value is 30.

See also setSafetyContour().

void EncMarinerSettings::setAreaSymbolizationType(EncAreaSymbolizationType type)

Sets the type of area symbolization to type.

This is used to specify whether areas should be symbolized with plain or traditional (symbolized) symbols. This controls the line symbol style for areas.

The default value is Symbolized.

Note: "Symbolized" area symbolization renders area symbols using the traditional paper chart symbology. Plain reduces clutter.

See also areaSymbolizationType().

void EncMarinerSettings::setColorScheme(EncColorScheme scheme)

Sets the color scheme to scheme.

The S52 standard allows for switching between three color modes: Day, Dusk and Night.

The default value is Day.

Note: This affects the color scheme used on all layers in the map.

See also colorScheme().

void EncMarinerSettings::setDataQuality(bool value)

Sets whether to the display the quality of data to value.

The default value is false, meaning that quality of data will not be displayed.

See also isDataQuality().

void EncMarinerSettings::setDeepContour(double meters)

Sets the deep contour depth to meters meters.

This must be greater than or equal to the safety contour value. An error will occur otherwise.

When four (rather than two) depth shades are used, this controls the boundary between safe and deep areas.

The default value is 30 (meters).

See also deepContour().

void EncMarinerSettings::setDisplayDepthUnits(EncDisplayDepthUnits displayDepthUnits)

Sets the depth units for soundings and contours for display to displayDepthUnits.

The default value is meters.

See also displayDepthUnits().

void EncMarinerSettings::setDisplayNobjnm(bool value)

Sets whether to display the national names to value.

This is text group 31 per IHO S-52 Annex A.

The default value is true, meaning national names will be displayed.

See also isDisplayNobjnm().

void EncMarinerSettings::setHonorScamin(bool value)

Sets whether the SCAMIN S-57 feature attribute will be honored to value.

The default value is true, meaning the 'SCAMIN' attribute will be honored.

See also isHonorScamin().

void EncMarinerSettings::setIsolatedDangers(bool value)

Sets whether to display the isolated dangers in shallow water to value.

The default value is false, meaning isolated dangers will not be shown in shallow water.

See also isIsolatedDangers().

void EncMarinerSettings::setLabelContours(bool value)

Sets whether to display the depth contour labels to value.

This includes the safety contour label.

This is viewing group 33021, 33022 per IHO S-52 Annex A.

The default value is true, meaning the depth contour labels will be displayed.

See also isLabelContours().

void EncMarinerSettings::setLabelSafetyContours(bool value)

Sets whether to display the safety contour labels to value.

The default value is true, meaning the safety contour labels will be displayed.

See also isLabelSafetyContours().

void EncMarinerSettings::setLowAccuracy(bool value)

Sets whether to use low accuracy symbols to value.

This is viewing group 31010 per IHO S-52 Annex A.

The default value is true, meaning vectors marked as 'low accuracy data' will be symbolized differently.

When set to false, low accuracy data will be visually indistinguishable from other data.

See also isLowAccuracy().

void EncMarinerSettings::setPointSymbolizationType(EncPointSymbolizationType type)

Sets the point feature symbolization type to type.

This is used to specify whether point features should be symbolized with simplified or paperchart symbols.

Paperchart symbolization is based on traditional paper charts. Simplified symbols are more compact and visible.

The default value is paperchart.

See also pointSymbolizationType().

void EncMarinerSettings::setSafetyContour(double meters)

Sets the depth of the safety contour in meters to meters.

The safety contour separates safe from unsafe areas.

The default value is 30.

See also safetyContour().

void EncMarinerSettings::setShallowContour(double meters)

Sets the depth of the shallow contour in meters to meters.

This must be less than or equal to the safety contour value. An error will occur otherwise.

When four (rather than two) depth shades are used, this value controls the separation between shallow and unsafe areas.

The default value is 2.

See also shallowContour().

void EncMarinerSettings::setShallowDepthPattern(bool value)

Sets whether to symbolize the shallow depth pattern to value.

The default value is false, meaning the shallow depth pattern will not be symbolized.

See also isShallowDepthPattern().

void EncMarinerSettings::setTwoDepthShades(bool value)

Sets whether to display the two depth shades to value.

The default value is true, meaning two rather than four depth shades will be used.

See also isTwoDepthShades().

double EncMarinerSettings::shallowContour() const

Gets the depth of the shallow contour in meters.

This must be less than or equal to the safety contour value. An error will occur otherwise.

When four (rather than two) depth shades are used, this value controls the separation between shallow and unsafe areas.

The default value is 2.

See also setShallowContour().


Feedback on this topic?