LuciadCPillar 2023.1.04
luciad::Map::FeatureQuery::Builder Class Referencefinal

Builder for a Map::FeatureQuery. More...

#include <luciad/maps/Map.h>

Public Member Functions

 Builder (Builder &&other) noexcept
 
 Builder (const Builder &other)
 
 ~Builder ()
 
Map::FeatureQuery build ()
 Creates the map feature query for the configured settings. More...
 
Builderfeatures (std::vector< LayerFeatureId > features)
 Sets the features to select for this query. More...
 
BuilderincludeControllerLayers (bool enable)
 Indicates if you want to query features on the controller layers in addition to the map layers. More...
 
Builderoperator= (Builder other) noexcept
 
Builderrectangle (Rectangle rectangle)
 The rectangle parameter is mandatory. More...
 

Detailed Description

Builder for a Map::FeatureQuery.

Constructor & Destructor Documentation

◆ ~Builder()

luciad::Map::FeatureQuery::Builder::~Builder ( )

◆ Builder() [1/2]

luciad::Map::FeatureQuery::Builder::Builder ( const Builder other)

◆ Builder() [2/2]

luciad::Map::FeatureQuery::Builder::Builder ( Builder &&  other)
noexcept

Member Function Documentation

◆ build()

Map::FeatureQuery luciad::Map::FeatureQuery::Builder::build ( )

Creates the map feature query for the configured settings.

Returns
the feature query.
Exceptions
luciad::LogicExceptionwhen not all mandatory parameters are set.

◆ features()

Builder & luciad::Map::FeatureQuery::Builder::features ( std::vector< LayerFeatureId features)

Sets the features to select for this query.

These features act as a filter on the result: the Map:queryFeatures method will only provide results for the given features.

Calling this method is optional. If it is not called, no filtering will be applied on the result.

Parameters
featuresthe features to include in the result
Returns
this

◆ includeControllerLayers()

Builder & luciad::Map::FeatureQuery::Builder::includeControllerLayers ( bool  enable)

Indicates if you want to query features on the controller layers in addition to the map layers.

Calling this method is optional, this value is false by default.

Parameters
enableif you want to query features on the controller layers in addition to the map layers.
Returns
this

◆ operator=()

Builder & luciad::Map::FeatureQuery::Builder::operator= ( Builder  other)
noexcept

◆ rectangle()

Builder & luciad::Map::FeatureQuery::Builder::rectangle ( Rectangle  rectangle)

The rectangle parameter is mandatory.

Parameters
rectanglethe rectangle the features must interact with. Defined in device independent pixels.
Returns
this