LuciadCPillar 2024.0.08
|
A Feature is a (partial) copy of a domain object. More...
#include <luciad/models/features/Feature.h>
Classes | |
class | Builder |
Allows the incremental creation of a Feature object. More... | |
Public Member Functions | |
Builder | asBuilder () const |
Returns this Feature as a Feature::Builder. More... | |
std::shared_ptr< Geometry > | findGeometry () const |
Tries to find a geometry for this feature. More... | |
const DataType & | getDataType () const |
Returns the data type describing the feature properties. More... | |
FeatureId | getId () const |
Returns the id of this feature. More... | |
template<typename T > | |
std::optional< T > | getValue (const DataPropertyPath &propertyPath) const |
Accesses the value for the given property. More... | |
bool | hasId () const |
Returns if this Feature has an id. More... | |
bool | operator!= (const Feature &other) const |
bool | operator== (const Feature &other) const |
Static Public Member Functions | |
static Builder | newBuilder () |
Returns a new Feature Builder. More... | |
A Feature is a (partial) copy of a domain object.
It allows the rest of the API to easily access the domain object's properties, including any geometry. If you do a query on the model, and retrieve a Feature from it, the caller of the query receives ownership of the Feature. I.e. the caller can decide what to do with it, and when to dispose it.
This means that the Map and Layer API's are allowed to keep references to a Feature and have unrestricted lock-less access to its properties. The caller of the IFeatureModel::query method is responsible for managing the lifetime of a Feature.
To make Feature instances easy to use in a multi-threaded environment, they are
See article for more details on this class.
Builder luciad::Feature::asBuilder | ( | ) | const |
Returns this Feature as a Feature::Builder.
This makes it possible to copy a Feature, and modify values. Note that when using this builder, it is not possible to change the datatype. Only the values and the id of the Feature. Otherwise a LogicException will be thrown.
std::shared_ptr< Geometry > luciad::Feature::findGeometry | ( | ) | const |
Tries to find a geometry for this feature.
If this feature's data type is annotated with GeometryDataAnnotation, the value of the corresponding property is returned. Otherwise, the result will be nullptr
.
nullptr
. const DataType & luciad::Feature::getDataType | ( | ) | const |
Returns the data type describing the feature properties.
FeatureId luciad::Feature::getId | ( | ) | const |
Returns the id of this feature.
A feature id should be unique across a model.
When no id is set
, this method will throw an exception.
LogicException | when the feature has no id. |
std::optional< T > luciad::Feature::getValue | ( | const DataPropertyPath & | propertyPath | ) | const |
Accesses the value for the given property.
T | the supported types are bool , int32_t , int64_t , float , double , std::string , std::shared_ptr<luciad::Geometry> or a subtype of Geometry . |
propertyPath | the property for which to return a value |
std::nullopt
is returned.InvalidArgumentException | when the property is not of a known type, if it doesn't exist in the DataType, or when the type of the value doesn't correspond with the provided type parameter (for example when the property value is a Point geometry, but it is requested using ArcBand as type parameter). |
bool luciad::Feature::hasId | ( | ) | const |
Returns if this Feature has an id.
If this method returns false, it is not allowed to call Feature::getId
.
|
static |
bool luciad::Feature::operator!= | ( | const Feature & | other | ) | const |
bool luciad::Feature::operator== | ( | const Feature & | other | ) | const |