Parameters for performing a query on a DynamicEntityDataSource. More...
| Header: | #include <DynamicEntityQueryParameters.h> |
| Since: | Esri::ArcGISRuntime 200.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| DynamicEntityQueryParameters(QObject *parent = nullptr) | |
| virtual | ~DynamicEntityQueryParameters() override |
| Esri::ArcGISRuntime::Geometry | geometry() const |
| void | setGeometry(const Esri::ArcGISRuntime::Geometry &geometry) |
| void | setSpatialRelationship(Esri::ArcGISRuntime::SpatialRelationship spatialRelationship) |
| void | setTrackIds(const QStringList &trackIds) |
| void | setWhereClause(const QString &whereClause) |
| Esri::ArcGISRuntime::SpatialRelationship | spatialRelationship() const |
| QStringList | trackIds() const |
| QString | whereClause() const |
Detailed Description
Use this class to specify parameters for querying dynamic entities in a DynamicEntityDataSource.
You may use any combination of trackIds, geometry, and whereClause to filter the dynamic entities returned by a query. Each of the properties will be applied to the query using an AND operation.
See also DynamicEntityDataSource::queryDynamicEntitiesAsync(DynamicEntityQueryParameters*, QObject*).
Member Function Documentation
[explicit] DynamicEntityQueryParameters::DynamicEntityQueryParameters (QObject *parent = nullptr)
Creates a new DynamicEntityQueryParameters object.
- parent - The optional parent QObject.
[override virtual noexcept] DynamicEntityQueryParameters::~DynamicEntityQueryParameters ()
destructor.
Esri::ArcGISRuntime::Geometry DynamicEntityQueryParameters::geometry() const
Returns the geometry used to filter the results.
The geometry that (along with the spatialRelationship) defines dynamic entities to be included in the query.
See also setGeometry().
void DynamicEntityQueryParameters::setGeometry (const Esri::ArcGISRuntime::Geometry &geometry)
Sets the geometry to geometry.
See also geometry.
void DynamicEntityQueryParameters::setSpatialRelationship (Esri::ArcGISRuntime::SpatialRelationship spatialRelationship )
Sets the spatialRelationship to spatialRelationship.
See also spatialRelationship.
void DynamicEntityQueryParameters::setTrackIds (const QStringList &trackIds )
Sets the trackIds to trackIds.
See also trackIds.
void DynamicEntityQueryParameters::setWhereClause (const QString &whereClause )
Sets the whereClause to whereClause.
See also whereClause.
Esri::ArcGISRuntime::SpatialRelationship DynamicEntityQueryParameters::spatialRelationship () const
Returns a SpatialRelationship object that defines how geometry is applied to filter the dynamic entities.
This property has no effect unless a geometry is also provided.
The default spatial relationship is SpatialRelationship::Intersects.
See also setSpatialRelationship().
QStringList DynamicEntityQueryParameters::trackIds () const
Returns the track IDs of the dynamic entities to query for.
If this array is populated, the query will only return entities with track IDs that match the values in this array.
The track ID is an attribute value in a DynamicEntityDataSource that uniquely identifies a dynamic entity. For an ArcGISStreamService, the track ID attribute is defined by the ArcGISStreamServiceInfo::trackIdField property. For a custom DynamicEntityDataSource, the track ID attribute is defined by the DynamicEntityDataSourceInfo::entityIdFieldName property.
See also setTrackIds().
QString DynamicEntityQueryParameters::whereClause () const
Returns the attribute query string used to filter the results.
The where clause should follow standard SQL syntax similar to that discussed in the document SQL reference for query expressions used in ArcGIS.
See also setWhereClause().