LuciadCPillar 2023.1.04
luciad::FeatureModelMetadata Class Referencefinal

This class exposes feature-specific metadata. More...

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

Classes

class  Builder
 The builder for creating luciad::FeatureModelMetadata classes. More...
 

Public Member Functions

DataModel getDataModel () const
 Returns the data model that describes how the Feature instances, returned by the IFeatureModel::query method, are structured. More...
 
std::vector< DataTypegetFeatureTypes () const
 Returns the data type types that are used for the actual Features of an IFeatureModel. More...
 
std::shared_ptr< CoordinateReferencegetReference () const
 Returns the preferred reference of this model, if available. More...
 

Static Public Member Functions

static Builder newBuilder ()
 Returns the builder instance for the creation of the FeatureModelMetadata. More...
 

Detailed Description

This class exposes feature-specific metadata.

Among others, it describes

  • The preferred reference used to interact with the model
  • The structure of the features in this model

Member Function Documentation

◆ getDataModel()

DataModel luciad::FeatureModelMetadata::getDataModel ( ) const

Returns the data model that describes how the Feature instances, returned by the IFeatureModel::query method, are structured.

Returns
the data model that describes how the Feature instances, returned by the IFeatureModel::query method, are structured.

◆ getFeatureTypes()

std::vector< DataType > luciad::FeatureModelMetadata::getFeatureTypes ( ) const

Returns the data type types that are used for the actual Features of an IFeatureModel.

This is a subset of the set of DataTypes available in getDataModel(). If the feature types are not known, no value can be returned.

Returns
the data types that are used for the actual Features of an IFeatureModel.
See also
DataType

◆ getReference()

std::shared_ptr< CoordinateReference > luciad::FeatureModelMetadata::getReference ( ) const

Returns the preferred reference of this model, if available.

For example, when performing a query with a bbox expression, performance will be best when this reference is used. Note that this doesn't mean that the reference of all features needs to be the same reference as this one. The returned value can be nullptr.

Returns
the preferred reference of this model, if available.

◆ newBuilder()

static Builder luciad::FeatureModelMetadata::newBuilder ( )
static

Returns the builder instance for the creation of the FeatureModelMetadata.

Returns
the builder instance for the creation of the FeatureModelMetadata.