LuciadCPillar 2024.0.08
|
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< Bounds > | getBounds () const |
Returns the bounds the queried features must interact with. More... | |
std::optional< Expression > | getCondition () 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< SortOperator > | getSortBy () 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... | |
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.
|
strong |
|
static |
This method is a convenience factory method that creates a query to retrieve all features.
std::optional< Bounds > luciad::FeatureQuery::getBounds | ( | ) | const |
Returns the bounds the queried features must interact with.
std::optional< Expression > luciad::FeatureQuery::getCondition | ( | ) | const |
Returns the condition that should be applied on the query, if any.
std::optional< std::vector< FeatureId > > luciad::FeatureQuery::getFeatureIds | ( | ) | const |
Returns the features to retrieve by id.
std::optional< uint32_t > luciad::FeatureQuery::getLimit | ( | ) | const |
Returns the maximum number of elements to query, if any.
std::optional< SortOperator > luciad::FeatureQuery::getSortBy | ( | ) | const |
Returns the sorting order that should be applied on the query, if any.
|
static |
Returns the builder class for creation of the feature query.