;

EncDisplayCategories Class

  • EncDisplayCategories
  • class Esri::ArcGISRuntime::EncDisplayCategories

    An Electronic Navigation Chart (ENC) display categories object. More...

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

    This class was introduced in Esri::ArcGISRuntime 100.2.

    Public Functions

    virtual ~EncDisplayCategories() override
    bool isDisplayBase() const
    bool isOtherDisplay() const
    bool isStandardDisplay() const
    void setDisplayBase(bool value)
    void setOtherDisplay(bool value)
    void setStandardDisplay(bool value)

    Detailed Description

    // get EncMarinerSettings instance
    EncDisplaySettings* encDisplaySettings = EncEnvironmentSettings::displaySettings();
    
    // get EncMarinerSettings instance
    EncMarinerSettings* encMarinerSettings = encDisplaySettings->marinerSettings();
    
    // get EncDisplayCategories instance
    EncDisplayCategories* encDisplayCategories = encMarinerSettings->displayCategories();
    
    // changes display categories settings
    encDisplayCategories->setStandardDisplay(false);

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

    See also EncLayer.

    Member Function Documentation

    [override virtual] EncDisplayCategories::~EncDisplayCategories()

    Destructor.

    bool EncDisplayCategories::isDisplayBase() const

    Returns whether to the display the S-52 "displaybase" category.

    bool EncDisplayCategories::isOtherDisplay() const

    Returns whether to the display the S-52 "other" category.

    bool EncDisplayCategories::isStandardDisplay() const

    Returns whether to the display the S-52 "standard" category.

    Note: Once an object has been added to or removed from display, the display is no longer showing the "Standard Display".

    void EncDisplayCategories::setDisplayBase(bool value)

    Sets whether to display the S-52 "displaybase" category to value.

    See also isDisplayBase().

    void EncDisplayCategories::setOtherDisplay(bool value)

    Sets whether to the display the S-52 "other" category to value.

    Note: The "other" category contains all objects that are not enabled by default in "Standard Display".

    See also isOtherDisplay().

    void EncDisplayCategories::setStandardDisplay(bool value)

    Sets whether to the display the S-52 "standard" category to value.

    See also isStandardDisplay().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.