;

FloorManager Class

  • FloorManager
  • class Esri::ArcGISRuntime::FloorManager

    A helper class for creating a UI with floor filtering functionality. More...

    Header: #include <FloorManager>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    virtual ~FloorManager() override
    QList<Esri::ArcGISRuntime::FloorFacility *> facilities() const
    Esri::ArcGISRuntime::Layer *facilityLayer() const
    Esri::ArcGISRuntime::Layer *levelLayer() const
    QList<Esri::ArcGISRuntime::FloorLevel *> levels() const
    Esri::ArcGISRuntime::Layer *siteLayer() const
    QList<Esri::ArcGISRuntime::FloorSite *> sites() const

    Reimplemented Public Functions

    virtual void cancelLoad() override
    virtual void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual void retryLoad() override

    Signals

    void doneLoading(Esri::ArcGISRuntime::Error loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    A FloorManager must be loaded before you can access its site, facility, and level properties. The FloorManager will fail to load if:

    • The map/scene associated with the floor manager is not floor-aware.
    • The mandatory facility or level layer doesn't exist.
    • It is unable to get the floor facilities or levels.
    • It is unable to get the floor sites from a specified site layer.

    See also Map.

    Member Function Documentation

    [signal] void FloorManager::doneLoading(Esri::ArcGISRuntime::Error loadError)

    Signal emitted when this object is done loading.

    • loadError - Details about any error that may have occurred

    Note: If there is a load error, it will also be emitted on the errorOccurred signal.

    See also Loadable and Object.

    [signal] void FloorManager::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the load status changes for this object.

    See also Loadable.

    [override virtual] FloorManager::~FloorManager()

    Destructor.

    [override virtual] void FloorManager::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    Cancels loading metadata for the object.

    Cancels loading the metadata if the object is loading and always calls doneLoading.

    QList<Esri::ArcGISRuntime::FloorFacility *> FloorManager::facilities() const

    Returns the collection of facilities.

    This property is initialized after the FloorManager is loaded.

    Esri::ArcGISRuntime::Layer *FloorManager::facilityLayer() const

    Returns the facility layer.

    This property is initialized after the FloorManager is loaded.

    Esri::ArcGISRuntime::Layer *FloorManager::levelLayer() const

    Returns the level layer.

    This property is initialized after the FloorManager is loaded.

    QList<Esri::ArcGISRuntime::FloorLevel *> FloorManager::levels() const

    Returns the floor levels.

    This property is initialized after the FloorManager is loaded.

    [override virtual] void FloorManager::load()

    Reimplements: Loadable::load().

    Loads the metadata for the object asynchronously.

    Loads the metadata if the object is not loaded and always calls doneLoading.

    [override virtual] Esri::ArcGISRuntime::Error FloorManager::loadError() const

    Reimplements: Loadable::loadError() const.

    Returns the load error.

    See also Error.

    [override virtual] Esri::ArcGISRuntime::LoadStatus FloorManager::loadStatus() const

    Reimplements: Loadable::loadStatus() const.

    Returns the load status.

    See also LoadStatus.

    [override virtual] void FloorManager::retryLoad()

    Reimplements: Loadable::retryLoad().

    Loads or retries loading metadata for the object asynchronously.

    Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.

    Esri::ArcGISRuntime::Layer *FloorManager::siteLayer() const

    Returns the site layer (optional).

    This property is initialized after the FloorManager is loaded.

    QList<Esri::ArcGISRuntime::FloorSite *> FloorManager::sites() const

    Returns the collection of sites, sorted by name.

    This property is initialized after the FloorManager is loaded.

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