;

FacilityLayerDefinition Class

  • FacilityLayerDefinition
  • class Esri::ArcGISRuntime::FacilityLayerDefinition

    Defines the layer and field properties for the layer that contains facilities for floor filtering. More...

    Header: #include <FacilityLayerDefinition>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::JsonSerializable

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    FacilityLayerDefinition(const QString &layerId, const QString &facilityIdField, const QString &nameField, const QString &siteIdField, QObject *parent = nullptr)
    virtual ~FacilityLayerDefinition() override
    QString facilityIdField() const
    QString layerId() const
    QString nameField() const
    QString siteIdField() const

    Reimplemented Public Functions

    virtual QString toJson() const override
    virtual QJsonObject unknownJson() const override
    virtual QJsonObject unsupportedJson() const override

    Static Public Members

    Esri::ArcGISRuntime::FacilityLayerDefinition *fromJson(const QString &json, QObject *parent = nullptr)

    Detailed Description

    A FacilityLayerDefinition describes the footprints of managed facilities. A facility represents any occupiable structure, such as an office or campus building, retail setting, or industrial structure. Facilities have one or more floor levels and are contained within a feature in the site layer (defined with SiteLayerDefinition).

    See also GeoModelFloorDefinition.

    Member Function Documentation

    FacilityLayerDefinition::FacilityLayerDefinition(const QString &layerId, const QString &facilityIdField, const QString &nameField, const QString &siteIdField, QObject *parent = nullptr)

    Creates a new FacilityLayerDefinition object with the specified layer id, facility id attribute field, facility name attribute field and site id attribute field.

    • layerId - An ID that specifies a layer in the map or scene that contains facilities.
    • facilityIdField - The name of the attribute field that contains a facility feature's unique identifier.
    • nameField - The name of the attribute field that contains a facility feature's name.
    • siteIdField - The name of the attribute field that contains a facility feature's site identifier (a foreign key to the layer that contains sites).
    • parent - The optional parent QObject.

    [override virtual] FacilityLayerDefinition::~FacilityLayerDefinition()

    Destructor.

    QString FacilityLayerDefinition::facilityIdField() const

    Returns the name of the attribute field that contains a facility feature's unique identifier.

    [static] Esri::ArcGISRuntime::FacilityLayerDefinition *FacilityLayerDefinition::fromJson(const QString &json, QObject *parent = nullptr)

    Converts a JSON string and returns an object.

    • json - The JSON string.
    • parent The parent object (optional).

    QString FacilityLayerDefinition::layerId() const

    Returns an ID that specifies a layer in the map or scene that contains facilities. The layer provides access to facility features for floor filtering.

    QString FacilityLayerDefinition::nameField() const

    Returns the name of the attribute field that contains each facility feature's name.

    QString FacilityLayerDefinition::siteIdField() const

    Returns the name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer).

    [override virtual] QString FacilityLayerDefinition::toJson() const

    Reimplements: JsonSerializable::toJson() const.

    Converts an object and returns a JSON string.

    [override virtual] QJsonObject FacilityLayerDefinition::unknownJson() const

    Reimplements: JsonSerializable::unknownJson() const.

    Returns unknown data from the source JSON.

    Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by the Runtime.

    See also JsonSerializable.

    [override virtual] QJsonObject FacilityLayerDefinition::unsupportedJson() const

    Reimplements: JsonSerializable::unsupportedJson() const.

    Returns unsupported data from the source JSON.

    Unsupported JSON is a dictionary of values that are supported by webmaps, but not exposed through the native Runtime API.

    See also JsonSerializable.

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