Skip To Content ArcGIS for Developers Sign In Dashboard

GenerateGeodatabaseParameters Class

(Esri::ArcGISRuntime::GenerateGeodatabaseParameters)

The parameters to sync data of a sync-enabled geodatabase. More...

Header: #include <GenerateGeodatabaseParameters>
Since: Esri::ArcGISRuntime 100.0

Public Functions

GenerateGeodatabaseParameters()
GenerateGeodatabaseParameters(const GenerateGeodatabaseParameters &other)
GenerateGeodatabaseParameters(GenerateGeodatabaseParameters &&other)
~GenerateGeodatabaseParameters()
AttachmentSyncDirection attachmentSyncDirection() const
Geometry extent() const
bool isEmpty() const
bool isReturnAttachments() const
QList<GenerateLayerOption> layerOptions() const
SpatialReference outSpatialReference() const
void setAttachmentSyncDirection(AttachmentSyncDirection attachmentSyncDirection)
void setExtent(const Geometry &extent)
void setLayerOptions(const QList<GenerateLayerOption> &generateLayerOptions)
void setOutSpatialReference(const SpatialReference &outSpatialReference)
void setReturnAttachments(bool returnAttachments)
void setSyncModel(SyncModel syncModel)
SyncModel syncModel() const
GenerateGeodatabaseParameters &operator=(const GenerateGeodatabaseParameters &other)
GenerateGeodatabaseParameters &operator=(GenerateGeodatabaseParameters &&other)

Detailed Description

The parameters to sync data of a sync-enabled geodatabase.

GenerateGeodatabaseParameters is used with GeodatabaseSyncTask::generateGeodatabase to generate sync-enabled geodatabases from supporting ArcGIS Feature services.

Note: Rather than constructing one of these directly, consider using the convenience method GeodatabaseSyncTask::createDefaultGenerateGeodatabaseParameters. It will create a GenerateGeodatabaseParameters object initialized with appropriate parameters based on the supported capabilities and data of the ArcGIS Feature Service.

Member Function Documentation

GenerateGeodatabaseParameters::GenerateGeodatabaseParameters()

Default constructor.

GenerateGeodatabaseParameters::GenerateGeodatabaseParameters(const GenerateGeodatabaseParameters &other)

Copy constructor from other GenerateGeodatabaseParameters.

GenerateGeodatabaseParameters::GenerateGeodatabaseParameters(GenerateGeodatabaseParameters &&other)

Move constructor from other GenerateGeodatabaseParameters.

GenerateGeodatabaseParameters::~GenerateGeodatabaseParameters()

Destructor.

AttachmentSyncDirection GenerateGeodatabaseParameters::attachmentSyncDirection() const

Returns the attachment sync direction.

See also setAttachmentSyncDirection().

Geometry GenerateGeodatabaseParameters::extent() const

Returns the geographic extent within which features will be included in the sync-enabled geodatabase.

To include non-spatial records, you must set up the LayerOptions for that layer to include a GenerateLayerOption::whereClause and set GenerateLayerOption::useGeometry to false.

See also setExtent().

bool GenerateGeodatabaseParameters::isEmpty() const

Returns whether this GenerateGeodatabaseParameters is empty.

bool GenerateGeodatabaseParameters::isReturnAttachments() const

Returns whether the sync-enabled geodatabase should contain attachments for the features that are included.

QList<GenerateLayerOption> GenerateGeodatabaseParameters::layerOptions() const

Returns the options specifiying how to filter features from individual layers for inclusion into the geodatabase.

See also setLayerOptions().

SpatialReference GenerateGeodatabaseParameters::outSpatialReference() const

Returns the spatial reference in which you would like the generated geodatabase.

See also setOutSpatialReference().

void GenerateGeodatabaseParameters::setAttachmentSyncDirection(AttachmentSyncDirection attachmentSyncDirection)

Sets the attachment sync direction.

  • attachmentSyncDirection - The directions to sync attachments.

This property specifies how the geodatabase should be configured to sync attachment data with its originating service.

See also attachmentSyncDirection().

void GenerateGeodatabaseParameters::setExtent(const Geometry &extent)

Sets the geographic extent of features to include in the geodatabase.

  • extent - The geographic extent.

See also extent().

void GenerateGeodatabaseParameters::setLayerOptions(const QList<GenerateLayerOption> &generateLayerOptions)

Sets the options specifiying how to filter features from individual layers for inclusion into the geodatabase.

  • generateLayerOptions - The options specifiying how to filter features.

If not specified, all features within the extent are included. For non-spatial records, set GenerateLayerOption::useGeometry to false and provide a GenerateLayerOption::whereClause.

See also layerOptions().

void GenerateGeodatabaseParameters::setOutSpatialReference(const SpatialReference &outSpatialReference)

Sets the spatial reference for the generated geodatabase.

  • outSpatialReference - The output spatial reference.

If the data on the server is not in this spatial reference, it will be reprojected before being included in the geodatabase.

See also outSpatialReference().

void GenerateGeodatabaseParameters::setReturnAttachments(bool returnAttachments)

Sets whether the sync-enabled geodatabase should contain attachments for the features that are included.

  • returnAttachments - Whether to include attachments.

This property only applies if the feature service supports attachments.

See also isReturnAttachments().

void GenerateGeodatabaseParameters::setSyncModel(SyncModel syncModel)

Sets the SyncModel.

  • syncModel - The sync model.

This property specifies whether the geodatabase should be configured to sync with the service as a whole (SyncModel::Geodatabase) or by individual layer or table (SyncModel::Layer).

See also syncModel().

SyncModel GenerateGeodatabaseParameters::syncModel() const

Returns the SyncModel.

See also setSyncModel().

GenerateGeodatabaseParameters &GenerateGeodatabaseParameters::operator=(const GenerateGeodatabaseParameters &other)

Assignment operator from other GenerateGeodatabaseParameters.

GenerateGeodatabaseParameters &GenerateGeodatabaseParameters::operator=(GenerateGeodatabaseParameters &&other)

Move operator from other GenerateGeodatabaseParameters.


Feedback on this topic?