Skip To Content ArcGIS for Developers Sign In Dashboard

EncTextGroupVisibilitySettings Class

(Esri::ArcGISRuntime::EncTextGroupVisibilitySettings)

Visibility settings for Electronic Navigation Chart (ENC) text groups. More...

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

Public Functions

~EncTextGroupVisibilitySettings()
bool isBerthNumber() const
bool isCurrentVelocity() const
bool isGeographicNames() const
bool isHeightOfIsletOrLandFeature() const
bool isImportantText() const
bool isLightDescription() const
bool isMagneticVariationAndSweptDepth() const
bool isNamesForPositionReporting() const
bool isNatureOfSeabed() const
bool isNoteOnChartData() const
void resetToDefaults()
void setBerthNumber(bool value)
void setCurrentVelocity(bool value)
void setGeographicNames(bool value)
void setHeightOfIsletOrLandFeature(bool value)
void setImportantText(bool value)
void setLightDescription(bool value)
void setMagneticVariationAndSweptDepth(bool value)
void setNamesForPositionReporting(bool value)
void setNatureOfSeabed(bool value)
void setNoteOnChartData(bool value)
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

Visibility settings for Electronic Navigation Chart (ENC) text groups.

// get ENC text group visibility settings object
EncTextGroupVisibilitySettings* encTextGroupVisibilitySettings = EncEnvironmentSettings::displaySettings()->textGroupVisibilitySettings();

// set properties
encTextGroupVisibilitySettings->setImportantText(false);
encTextGroupVisibilitySettings->setNatureOfSeabed(false);

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

See also EncLayer.

Member Function Documentation

EncTextGroupVisibilitySettings::~EncTextGroupVisibilitySettings()

Destructor.

bool EncTextGroupVisibilitySettings::isBerthNumber() const

Returns whether the "berth number" text group should be visible.

Per IHO S-52 Annex A, controls text group 29, which includes OBJNAM from BERTHS and ACHBRT.

bool EncTextGroupVisibilitySettings::isCurrentVelocity() const

Returns whether the "current velocity" text group should be visible.

Per IHO S-52 Annex A, controls text group 30, which includes CURVEL.

bool EncTextGroupVisibilitySettings::isGeographicNames() const

Returns whether the "geographic names" text group should be visible.

Per IHO S-52 Annex A, controls text group 26, which includes OBJNAM from ACHARE, BRIDGE, BUAARE, BUISGL, DOCARE, FAIRWY, LNDARE, LNDMARK, LNDRGN, SEAARE, TIDEWY, and PILBOP.

bool EncTextGroupVisibilitySettings::isHeightOfIsletOrLandFeature() const

Returns whether the "height of islet or land feature" text group should be visible.

Per IHO S-52 Annex A, controls text group 28, which includes HEIGHT of LNDARE.

bool EncTextGroupVisibilitySettings::isImportantText() const

Returns whether the "important text" group should be visible.

Per IHO S-52 Annex A, controls text groups 10 and 11.

bool EncTextGroupVisibilitySettings::isLightDescription() const

Returns whether the "light description" text group should be visible.

Per IHO S-52 Annex A, controls text group 23.

bool EncTextGroupVisibilitySettings::isMagneticVariationAndSweptDepth() const

Returns whether the "magnetic variation and swept depth" text group should be visible.

Per IHO S-52 Annex A, controls text group 27, which includes MAGVAR, VALMAG, SWPARE, and DRVAL1.

bool EncTextGroupVisibilitySettings::isNamesForPositionReporting() const

Returns whether the "names for position reporting" text group should be visible.

Per IHO S-52 Annex A, controls text group 21.

bool EncTextGroupVisibilitySettings::isNatureOfSeabed() const

Returns whether the "nature of seabed" text group should be visible.

Per IHO S-52 Annex A, controls text group 25 (SBDARE, NATSUR).

bool EncTextGroupVisibilitySettings::isNoteOnChartData() const

Returns whether the "note on chart data" text group should be visible.

Per IHO S-52 Annex A, controls text group 24.

void EncTextGroupVisibilitySettings::resetToDefaults()

Resets each S-52 text group property to its respective default.

void EncTextGroupVisibilitySettings::setBerthNumber(bool value)

Sets whether the "berth number" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 29, which includes OBJNAM from BERTHS and ACHBRT.

See also isBerthNumber().

void EncTextGroupVisibilitySettings::setCurrentVelocity(bool value)

Sets whether the "current velocity" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 30, which includes CURVEL.

See also isCurrentVelocity().

void EncTextGroupVisibilitySettings::setGeographicNames(bool value)

Sets whether the "geographic names" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 26, which includes OBJNAM from ACHARE, BRIDGE, BUAARE, BUISGL, DOCARE, FAIRWY, LNDARE, LNDMARK, LNDRGN, SEAARE, TIDEWY, and PILBOP.

See also isGeographicNames().

void EncTextGroupVisibilitySettings::setHeightOfIsletOrLandFeature(bool value)

Sets whether the "height of islet or land feature" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 28, which includes HEIGHT of LNDARE.

See also isHeightOfIsletOrLandFeature().

void EncTextGroupVisibilitySettings::setImportantText(bool value)

Sets whether the "important text" group should be visible to value.

Per IHO S-52 Annex A, controls text groups 10 and 11.

See also isImportantText().

void EncTextGroupVisibilitySettings::setLightDescription(bool value)

Sets whether the "light description" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 23.

See also isLightDescription().

void EncTextGroupVisibilitySettings::setMagneticVariationAndSweptDepth(bool value)

Sets whether the "magnetic variation and swept depth" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 27, which includes MAGVAR, VALMAG, SWPARE, and DRVAL1.

See also isMagneticVariationAndSweptDepth().

void EncTextGroupVisibilitySettings::setNamesForPositionReporting(bool value)

Sets whether the "names for position reporting" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 21.

See also isNamesForPositionReporting().

void EncTextGroupVisibilitySettings::setNatureOfSeabed(bool value)

Sets whether the "nature of seabed" text group should be visible to value.

Per IHO S-52 Annex A, controls text group 25 (SBDARE, NATSUR).

See also isNatureOfSeabed().

void EncTextGroupVisibilitySettings::setNoteOnChartData(bool value)

Sets whether the "note on chart" data text group should be visible to value.

Per IHO S-52 Annex A, controls text group 24.

See also isNoteOnChartData().


Feedback on this topic?