LuciadCPillar C# 2023.1.04
Luciad.Models.Features.FeatureQuery Class Reference

A query specifies which objects you are interested in. More...

Inheritance diagram for Luciad.Models.Features.FeatureQuery:

Classes

class  Builder
 Builder to create a FeatureQuery. More...
 
class  SortOperator
 SortOperator class contains a list of properties that must be taken into account for sorting. More...
 
class  SortProperty
 SortProperty class defines the property name and the sort order for the SortOperator. More...
 

Public Types

enum  SortOrder { Asc , Desc }
 Sort order. More...
 

Public Member Functions

void Dispose ()
 

Static Public Member Functions

static Luciad.Models.Features.FeatureQuery All ()
 This method is a convenience factory method that creates a query to retrieve all features. More...
 
static Luciad.Models.Features.FeatureQuery.Builder NewBuilder ()
 Returns the builder class for creation of the feature query. More...
 

Properties

Luciad.Geometries.Bounds Bounds [get]
 
Luciad.Expressions.Expression Condition [get]
 
System.Collections.Generic.IList< ulong > FeatureIds [get]
 
uint? Limit [get]
 
Luciad.Models.Features.FeatureQuery.SortOperator SortBy [get]
 

Detailed Description

A query specifies which objects you are interested in.

It is a combination of:

Bounds

Condition

Feature Ids

Order

Limit

All of these are optional. The query implementation must use all settings on the Query instance. For example, if both a bounds and a condition are specified, the query implementation must take both the bounds and the condition into account. Create an empty Query to get all objects. When both a condition and feature ids are provided in the Query the objects need to fulfill both.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery.

Member Enumeration Documentation

◆ SortOrder

Sort order.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery::SortOrder.
Enumerator
Asc 

Ascending sorrt order.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery::SortOrder::Asc.
Desc 

Descending sort order.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery::SortOrder::Desc.

Member Function Documentation

◆ All()

Luciad.Models.Features.FeatureQuery Luciad.Models.Features.FeatureQuery.All ( )
inlinestatic

This method is a convenience factory method that creates a query to retrieve all features.

a query to retrieve all features.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery::all.

◆ Dispose()

void Luciad.Models.Features.FeatureQuery.Dispose ( )
inline

◆ NewBuilder()

Luciad.Models.Features.FeatureQuery.Builder Luciad.Models.Features.FeatureQuery.NewBuilder ( )
inlinestatic

Returns the builder class for creation of the feature query.

the builder class for creation of the feature query.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureQuery::newBuilder.

Property Documentation

◆ Bounds

Luciad.Geometries.Bounds Luciad.Models.Features.FeatureQuery.Bounds
get

◆ Condition

Luciad.Expressions.Expression Luciad.Models.Features.FeatureQuery.Condition
get

◆ FeatureIds

System.Collections.Generic.IList<ulong> Luciad.Models.Features.FeatureQuery.FeatureIds
get

◆ Limit

uint? Luciad.Models.Features.FeatureQuery.Limit
get

◆ SortBy

Luciad.Models.Features.FeatureQuery.SortOperator Luciad.Models.Features.FeatureQuery.SortBy
get