TableDescription Class

  • TableDescription
  • class Esri::ArcGISRuntime::TableDescription

    An object that describes a GeodatabaseFeatureTable to be created. Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via Geodatabase::create(QString). More...

    Header: #include <TableDescription>
    Since: Esri::ArcGISRuntime 100.14
    Inherits: Esri::ArcGISRuntime::Object

    This class was introduced in Esri::ArcGISRuntime 100.14.

    Public Functions

    TableDescription(const QString &name, const Esri::ArcGISRuntime::SpatialReference &spatialReference, Esri::ArcGISRuntime::GeometryType geometryType, QObject *parent = nullptr)
    TableDescription(const QString &name, QObject *parent = nullptr)
    virtual ~TableDescription() override
    Esri::ArcGISRuntime::FieldDescriptionListModel *fieldDescriptions() const
    Esri::ArcGISRuntime::GeometryType geometryType() const
    bool hasAttachments() const
    bool hasM() const
    bool hasZ() const
    void setGeometryType(Esri::ArcGISRuntime::GeometryType geometryType)
    void setHasAttachments(bool hasAttachments)
    void setHasM(bool hasM)
    void setHasZ(bool hasZ)
    void setSpatialReference(const Esri::ArcGISRuntime::SpatialReference &spatialReference)
    void setTableName(const QString &tableName)
    Esri::ArcGISRuntime::SpatialReference spatialReference() const
    QString tableName() const

    Detailed Description

    Member Function Documentation

    TableDescription::TableDescription(const QString &name, const Esri::ArcGISRuntime::SpatialReference &spatialReference, Esri::ArcGISRuntime::GeometryType geometryType, QObject *parent = nullptr)

    Creates a new table description object with the specified name, spatial reference, and geometry type.

    • name - The field's name.
    • spatialReference - The table's spatial reference.
    • geometryType - The table's geometry type.
    • parent - The optional parent QObject.

    TableDescription::TableDescription(const QString &name, QObject *parent = nullptr)

    Creates a new table description object with the specified name.

    • name - The table's name.
    • parent - The optional parent QObject.

    [override virtual] TableDescription::~TableDescription()

    Destructor.

    Esri::ArcGISRuntime::FieldDescriptionListModel *TableDescription::fieldDescriptions() const

    Returns the descriptions of the fields to be created. If no ObjectID field is provided, one will be automatically added.

    Esri::ArcGISRuntime::GeometryType TableDescription::geometryType() const

    Returns the type of geometry to be used by features in the table. The default geometry type is GeometryType::Unknown and represents a non-spatial table. When setting a known geometry type, the spatial reference also needs to be specified via the spatialReference property.

    See also setGeometryType().

    bool TableDescription::hasAttachments() const

    Returns true if the features should support attachments. The default value is false. Enabling attachments requires a GlobalID field.

    See also setHasAttachments().

    bool TableDescription::hasM() const

    Returns true if the feature geometries should contain m-values. The default value is false.

    See also setHasM().

    bool TableDescription::hasZ() const

    Returns true if the feature geometries should contain z-values. The default value is false.

    See also setHasZ().

    void TableDescription::setGeometryType(Esri::ArcGISRuntime::GeometryType geometryType)

    Sets the geometryType to geometryType.

    See also geometryType.

    void TableDescription::setHasAttachments(bool hasAttachments)

    Sets the hasAttachments to hasAttachments.

    See also hasAttachments.

    void TableDescription::setHasM(bool hasM)

    Sets the hasM to hasM.

    See also hasM.

    void TableDescription::setHasZ(bool hasZ)

    Sets the hasZ to hasZ.

    See also hasZ.

    void TableDescription::setSpatialReference(const Esri::ArcGISRuntime::SpatialReference &spatialReference)

    Sets the spatialReference to spatialReference.

    See also spatialReference.

    void TableDescription::setTableName(const QString &tableName)

    Sets the tableName to tableName.

    See also tableName.

    Esri::ArcGISRuntime::SpatialReference TableDescription::spatialReference() const

    Returns the spatial reference to be used by feature geometries in the table.

    The default spatial reference is an empty object and represents a non-spatial table. When setting to a non-empty spatial reference, the geometry type also needs to be specified via the geometryType property.

    See also setSpatialReference().

    QString TableDescription::tableName() const

    Returns the table's name. The table name must be non-empty, consist only of alphanumeric characters and underscores, and cannot start with a number or an underscore.

    See also setTableName().

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close