LuciadCPillar 2024.1.04
luciad::GeometryDataAnnotation Class Referencefinal

DataAnnotation that is added on a DataType to define which property path contains the main geometry. More...

#include <luciad/datamodels/GeometryDataAnnotation.h>

Inheritance diagram for luciad::GeometryDataAnnotation:
luciad::DataAnnotation

Public Member Functions

 GeometryDataAnnotation (DataPropertyPath propertyPath)
 Creates a new GeometryDataAnnotation instance. More...
 
size_t getHash () const override
 Returns the hash code. More...
 
const DataPropertyPathgetPropertyPath () const
 Returns the geometry property path for the type annotated with this annotation. More...
 
bool operator!= (const DataAnnotation &other) const override
 
bool operator== (const DataAnnotation &other) const override
 
- Public Member Functions inherited from luciad::DataAnnotation
virtual ~DataAnnotation ()=default
 
virtual size_t getHash () const =0
 Returns the hash value for this annotation. More...
 
virtual bool operator!= (const DataAnnotation &other) const =0
 
virtual bool operator== (const DataAnnotation &other) const =0
 

Static Public Member Functions

static std::shared_ptr< GeometryDataAnnotationfind (const DataType &type)
 Searches for the geometry data annotation on a give data type. More...
 

Detailed Description

DataAnnotation that is added on a DataType to define which property path contains the main geometry.

The referred-to property must have Geometry as its data type.

See also
DataPropertyPath

Constructor & Destructor Documentation

◆ GeometryDataAnnotation()

luciad::GeometryDataAnnotation::GeometryDataAnnotation ( DataPropertyPath  propertyPath)
explicit

Creates a new GeometryDataAnnotation instance.

Parameters
propertyPaththe path to the data property that contains the geometry.

Member Function Documentation

◆ find()

static std::shared_ptr< GeometryDataAnnotation > luciad::GeometryDataAnnotation::find ( const DataType type)
static

Searches for the geometry data annotation on a give data type.

Parameters
typethe data type.
Returns
the geometry annotation found. Can be nullptr if not found.

◆ getHash()

size_t luciad::GeometryDataAnnotation::getHash ( ) const
overridevirtual

Returns the hash code.

Returns
the hash code.

Implements luciad::DataAnnotation.

◆ getPropertyPath()

const DataPropertyPath & luciad::GeometryDataAnnotation::getPropertyPath ( ) const

Returns the geometry property path for the type annotated with this annotation.

Returns
the geometry property path for the type annotated with this annotation.

◆ operator!=()

bool luciad::GeometryDataAnnotation::operator!= ( const DataAnnotation other) const
overridevirtual

◆ operator==()

bool luciad::GeometryDataAnnotation::operator== ( const DataAnnotation other) const
overridevirtual