LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::FeatureQuery Class Reference

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

#include <luciad/models/features/FeatureQuery.h>

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 class  SortOrder { Asc , Desc }
 Sort order. More...
 

Public Member Functions

std::optional< BoundsgetBounds () const
 Returns the bounds the queried features must interact with. More...
 
std::optional< ExpressiongetCondition () const
 Returns the condition that should be applied on the query, if any. More...
 
std::optional< std::vector< FeatureId > > getFeatureIds () const
 Returns the features to retrieve by id. More...
 
std::optional< uint32_t > getLimit () const
 Returns the maximum number of elements to query, if any. More...
 
std::optional< SortOperatorgetSortBy () const
 Returns the sorting order that should be applied on the query, if any. More...
 

Static Public Member Functions

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

Detailed Description

A query specifies which objects you are interested in.

It is a combination of:

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.

Member Enumeration Documentation

◆ SortOrder

Sort order.

Enumerator
Asc 

Ascending sorrt order.

Desc 

Descending sort order.

Member Function Documentation

◆ all()

static FeatureQuery luciad::FeatureQuery::all ( )
static

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

Returns
a query to retrieve all features.

◆ getBounds()

std::optional< Bounds > luciad::FeatureQuery::getBounds ( ) const

Returns the bounds the queried features must interact with.

Returns
the bounds the queried features must interact with.

◆ getCondition()

std::optional< Expression > luciad::FeatureQuery::getCondition ( ) const

Returns the condition that should be applied on the query, if any.

Returns
the condition that should be applied on the query, if any.

◆ getFeatureIds()

std::optional< std::vector< FeatureId > > luciad::FeatureQuery::getFeatureIds ( ) const

Returns the features to retrieve by id.

Returns
the features to retrieve by id.

◆ getLimit()

std::optional< uint32_t > luciad::FeatureQuery::getLimit ( ) const

Returns the maximum number of elements to query, if any.

Returns
the maximum number of elements to query, if any.

◆ getSortBy()

std::optional< SortOperator > luciad::FeatureQuery::getSortBy ( ) const

Returns the sorting order that should be applied on the query, if any.

Returns
the sorting order that should be applied on the query, if any.

◆ newBuilder()

static Builder luciad::FeatureQuery::newBuilder ( )
static

Returns the builder class for creation of the feature query.

Returns
the builder class for creation of the feature query.