ArcGIS Developers

RelatedFeatureQueryResult Class

class Esri::ArcGISRuntime::RelatedFeatureQueryResult

Contains the features that have been returned from a related tables query. More...

Header: #include <RelatedFeatureQueryResult>
Since: Esri::ArcGISRuntime 100.1
Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::FeatureSet

This class was introduced in Esri::ArcGISRuntime 100.1.

Public Functions

virtual ~RelatedFeatureQueryResult() override
Esri::ArcGISRuntime::ArcGISFeature *feature() const
bool isTransferLimitExceeded() const
Esri::ArcGISRuntime::ArcGISFeatureTable *relatedTable() const
Esri::ArcGISRuntime::RelationshipInfo relationshipInfo() const

Reimplemented Public Functions

virtual QList<Esri::ArcGISRuntime::Field> fields() const override
virtual Esri::ArcGISRuntime::GeometryType geometryType() const override
virtual Esri::ArcGISRuntime::FeatureIterator iterator() const override
virtual Esri::ArcGISRuntime::SpatialReference spatialReference() const override

Detailed Description

An instance of this class represents the result of related queries. A prerequisite for querying related features is that all the participating tables must be part of a map, as either feature layers or non-spatial tables. An array of instances are returned, one per related table containing features related to the queried feature. This class has methods that can be used to iterate over the collection of related features

Member Function Documentation

[override virtual] RelatedFeatureQueryResult::~RelatedFeatureQueryResult()


Esri::ArcGISRuntime::ArcGISFeature *RelatedFeatureQueryResult::feature() const

Returns the feature for which related features were queried.

[override virtual] QList<Esri::ArcGISRuntime::Field> RelatedFeatureQueryResult::fields() const

Reimplements: FeatureSet::fields() const.

Returns a list of Field objects representing the fields in this RelatedFeatureQueryResult.

[override virtual] Esri::ArcGISRuntime::GeometryType RelatedFeatureQueryResult::geometryType() const

Reimplements: FeatureSet::geometryType() const.

Returns the type of geometry shared by all features in this RelatedFeatureQueryResult.

This property is GeometryType::Unknown when the related table has no geometry field.

bool RelatedFeatureQueryResult::isTransferLimitExceeded() const

Returns true if the result does not include all the features matched by the query.

Many ArcGIS services only return up to 1000 features even if the query matched more features. When that happens for the query that produces this result, this property is true.

[override virtual] Esri::ArcGISRuntime::FeatureIterator RelatedFeatureQueryResult::iterator() const

Reimplements: FeatureSet::iterator() const.

Returns an iterator used to iterate over all features in this RelatedFeatureQueryResult

Esri::ArcGISRuntime::ArcGISFeatureTable *RelatedFeatureQueryResult::relatedTable() const

Returns the related table for this query result.

There can be more than one instance of the same table or layer on the map with different scale level visibility, definition expression, and so on. All such instances share the same RelationshipInfo with the table the query operation is called on. In such cases, results from all such instances are returned, and relatedTable is used to distinguish between them.

Esri::ArcGISRuntime::RelationshipInfo RelatedFeatureQueryResult::relationshipInfo() const

Returns the relationship info for this query result.

If more than one related table were queried, multiple results are returned, each with its RelationshipInfo.

[override virtual] Esri::ArcGISRuntime::SpatialReference RelatedFeatureQueryResult::spatialReference() const

Reimplements: FeatureSet::spatialReference() const.

Returns the spatial reference shared by all features in this RelatedFeatureQueryResult.

This property is set to an empty SpatialReference when the related table has no spatial reference.

Feedback on this topic?