EncViewingGroupSettings Class
An Electronic Navigation Chart (ENC) viewing group settings object. More...
| Header: | #include <EncViewingGroupSettings> |
| Since: | Esri::ArcGISRuntime 100.2 |
| Inherits: | Esri::ArcGISRuntime::Object |
This class was introduced in Esri::ArcGISRuntime 100.2.
Public Functions
Detailed Description
// get ENC viewing group settings object
EncViewingGroupSettings* encViewingGroupSettings = EncEnvironmentSettings::displaySettings()->viewingGroupSettings();
// set properties
encViewingGroupSettings->setBuoysBeaconsAidsToNavigation(false);
encViewingGroupSettings->setDryingLine(false);Note: You cannot create an object of this class. Use EncDisplaySettings to get an instance.
See also EncLayer.
Member Function Documentation
[override virtual] EncViewingGroupSettings::~EncViewingGroupSettings()
Destructor.
bool EncViewingGroupSettings::isAllIsolatedDangers() const
Returns whether "all isolated dangers" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 13, which includes viewing groups 34050 and 34051.
bool EncViewingGroupSettings::isArchipelagicSeaLanes() const
Returns whether the "archipelagic sea lanes" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 9, which includes viewing group 26260.
bool EncViewingGroupSettings::isBoundariesAndLimits() const
Returns whether the "boundaries and limits" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 4, which includes viewing groups 23030, 26050, 26220, 26240, and 26250.
bool EncViewingGroupSettings::isBuoysBeaconsAidsToNavigation() const
Returns whether the "buoys, beacons, aids to navigation" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 3, which includes viewing groups 21020, 22200 - 22240, 27000, 27010, 27011, 27020, 27025, 27040, 27050, 27070, 27080, 27200, 27210, 27230, 27030, and 27060.
bool EncViewingGroupSettings::isBuoysBeaconsStructures() const
Returns whether the "buoys, beacons, structures" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 3.1, which includes viewing groups 21010, 21020, 22200 - 22240, 27000-27050, 27080, 27200 - 27230, 27030, and 27060.
bool EncViewingGroupSettings::isChartScaleBoundaries() const
Returns whether the "chart scale boundaries" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 6, which includes viewing group 21030.
bool EncViewingGroupSettings::isDepthContours() const
Returns whether the "depth contours" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 15, which includes viewing group 33020.
bool EncViewingGroupSettings::isDryingLine() const
Returns whether the "drying line" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 2, which includes viewing group 22010.
bool EncViewingGroupSettings::isLights() const
Returns whether the "lights" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 3.2, which includes viewing group 27070.
bool EncViewingGroupSettings::isMagneticVariation() const
Returns whether the "magnetic variation" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 14, which includes viewing group 31080.
bool EncViewingGroupSettings::isOtherMiscellaneous() const
Returns whether the "other miscellaneous" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 18, which includes viewing group 30000-39999.
bool EncViewingGroupSettings::isProhibitedAndRestrictedAreas() const
Returns whether the "prohibited and restricted areas" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 5, which includes viewing groups 2600, 26010, and 26040.
bool EncViewingGroupSettings::isSeabed() const
Returns whether the "seabed" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 16, which includes viewing groups 34010, 34020, and 33040.
bool EncViewingGroupSettings::isShipsRoutingSystemsAndFerryRoutes() const
Returns whether the "ships' routing systems and ferry routes" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 8, which includes viewing groups 25010-25060.
bool EncViewingGroupSettings::isSpotSoundings() const
Returns whether the "spot soundings" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 11, which includes viewing group 33010.
bool EncViewingGroupSettings::isStandardMiscellaneous() const
Returns whether the "standard miscellaneous" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 10 under the "standard display" viewing group, which includes all objects not covered by viewing groups 20000-29999.
bool EncViewingGroupSettings::isSubmarineCablesAndPipelines() const
Returns whether the "submarine cables and pipelines" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 12, which includes viewing groups 34030 and 34070.
bool EncViewingGroupSettings::isTidal() const
Returns whether the "tidal" view group should be visible.
Per IHO S-52 Annex A, controls viewing group layer 17, which includes viewing groups 33050 and 33060.
void EncViewingGroupSettings::resetToDefaults()
Resets all S-52 view group properties to their default values.
void EncViewingGroupSettings::setAllIsolatedDangers(bool value)
Sets whether "all isolated dangers" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 13, which includes viewing groups 34050 and 34051.
See also isAllIsolatedDangers().
void EncViewingGroupSettings::setArchipelagicSeaLanes(bool value)
Sets whether the "archipelagic sea lanes" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 9, which includes viewing group 26260.
See also isArchipelagicSeaLanes().
void EncViewingGroupSettings::setBoundariesAndLimits(bool value)
Sets whether the "boundaries and limits" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 4, which includes viewing groups 23030, 26050, 26220, 26240, and 26250.
See also isBoundariesAndLimits().
void EncViewingGroupSettings::setBuoysBeaconsAidsToNavigation(bool value)
Sets whether the "buoys, beacons, aids to navigation" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 3, which includes viewing groups 21020, 22200 - 22240, 27000, 27010, 27011, 27020, 27025, 27040, 27050, 27070, 27080, 27200, 27210, 27230, 27030, and 27060.
See also isBuoysBeaconsAidsToNavigation().
void EncViewingGroupSettings::setBuoysBeaconsStructures(bool value)
Sets whether the "buoys, beacons, structures" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 3.1, which includes viewing groups 21010, 21020, 22200 - 22240, 27000-27050, 27080, 27200 - 27230, 27030, and 27060.
See also isBuoysBeaconsStructures().
void EncViewingGroupSettings::setChartScaleBoundaries(bool value)
Sets whether the "chart scale boundaries" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 6, which includes viewing group 21030.
See also isChartScaleBoundaries().
void EncViewingGroupSettings::setDepthContours(bool value)
Sets whether the "depth contours" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 15, which includes viewing group 33020.
See also isDepthContours().
void EncViewingGroupSettings::setDryingLine(bool value)
Sets whether the "drying line" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 2, which includes viewing group 22010.
See also isDryingLine().
void EncViewingGroupSettings::setLights(bool value)
Sets whether the "lights" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 3.2, which includes viewing group 27070.
See also isLights().
void EncViewingGroupSettings::setMagneticVariation(bool value)
Sets whether the "magnetic variation" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 14, which includes viewing group 31080.
See also isMagneticVariation().
void EncViewingGroupSettings::setOtherMiscellaneous(bool value)
Sets whether the "other miscellaneous" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 18, which includes viewing group 30000-39999.
See also isOtherMiscellaneous().
void EncViewingGroupSettings::setProhibitedAndRestrictedAreas(bool value)
Sets whether the "prohibited and restricted areas" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 5, which includes viewing groups 2600, 26010, and 26040.
See also isProhibitedAndRestrictedAreas().
void EncViewingGroupSettings::setSeabed(bool value)
Sets whether the "seabed" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 16, which includes viewing groups 34010, 34020, and 33040.
See also isSeabed().
void EncViewingGroupSettings::setShipsRoutingSystemsAndFerryRoutes(bool value)
Sets whether the "ships' routing systems and ferry routes" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 8, which includes viewing groups 25010-25060.
See also isShipsRoutingSystemsAndFerryRoutes().
void EncViewingGroupSettings::setSpotSoundings(bool value)
Sets whether the "spot soundings" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 11, which includes viewing group 33010.
See also isSpotSoundings().
void EncViewingGroupSettings::setStandardMiscellaneous(bool value)
Sets whether the "standard miscellaneous" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 10 under the "standard display" viewing group, which includes all objects not covered by viewing groups 20000-29999.
See also isStandardMiscellaneous().
void EncViewingGroupSettings::setSubmarineCablesAndPipelines(bool value)
Sets whether the "submarine cables and pipelines" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 12, which includes viewing groups 34030 and 34070.
See also isSubmarineCablesAndPipelines().
void EncViewingGroupSettings::setTidal(bool value)
Sets whether the "tidal" view group should be visible to value.
Per IHO S-52 Annex A, controls viewing group layer 17, which includes viewing groups 33050 and 33060.
See also isTidal().