GDAL
Public Member Functions | Static Public Member Functions | List of all members
OGRFieldDomain Class Referenceabstract

Definition of a field domain. More...

#include <ogr_feature.h>

Inheritance diagram for OGRFieldDomain:
OGRCodedFieldDomain OGRGlobFieldDomain OGRRangeFieldDomain

Public Member Functions

virtual ~OGRFieldDomain ()=0
 Destructor.
 
virtual OGRFieldDomainClone () const =0
 Clone.
 
const std::string & GetName () const
 Get the name of the field domain.
 
const std::string & GetDescription () const
 Get the description of the field domain.
 
OGRFieldDomainType GetDomainType () const
 Get the type of the field domain.
 
OGRFieldType GetFieldType () const
 Get the field type.
 
OGRFieldSubType GetFieldSubType () const
 Get the field subtype.
 
OGRFieldDomainSplitPolicy GetSplitPolicy () const
 Get the split policy.
 
void SetSplitPolicy (OGRFieldDomainSplitPolicy policy)
 Set the split policy.
 
OGRFieldDomainMergePolicy GetMergePolicy () const
 Get the merge policy.
 
void SetMergePolicy (OGRFieldDomainMergePolicy policy)
 Set the merge policy.
 

Static Public Member Functions

static OGRFieldDomainH ToHandle (OGRFieldDomain *poFieldDomain)
 Convert a OGRFieldDomain* to a OGRFieldDomainH.
 
static OGRFieldDomainFromHandle (OGRFieldDomainH hFieldDomain)
 Convert a OGRFieldDomainH to a OGRFieldDomain*.
 

Detailed Description

Definition of a field domain.

A field domain is a set of constraints that apply to one or several fields.

This is a concept found in File Geodatabase or GeoPackage (using the schema extension) for example.

A field domain can be:

Since
GDAL 3.3

Constructor & Destructor Documentation

◆ ~OGRFieldDomain()

OGRFieldDomain::~OGRFieldDomain ( )
pure virtualdefault

Destructor.

This is the same as the C function OGR_FldDomain_Destroy().

Member Function Documentation

◆ Clone()

virtual OGRFieldDomain * OGRFieldDomain::Clone ( ) const
pure virtual

Clone.

Return a cloned object, or nullptr in case of error.

Implemented in OGRCodedFieldDomain, OGRRangeFieldDomain, and OGRGlobFieldDomain.

◆ GetDescription()

const std::string & OGRFieldDomain::GetDescription ( ) const
inline

Get the description of the field domain.

Empty string if there is none.

This is the same as the C function OGR_FldDomain_GetDescription().

◆ GetDomainType()

OGRFieldDomainType OGRFieldDomain::GetDomainType ( ) const
inline

Get the type of the field domain.

This is the same as the C function OGR_FldDomain_GetDomainType().

◆ GetFieldSubType()

OGRFieldSubType OGRFieldDomain::GetFieldSubType ( ) const
inline

Get the field subtype.

This is the same as the C function OGR_FldDomain_GetFieldSubType().

◆ GetFieldType()

OGRFieldType OGRFieldDomain::GetFieldType ( ) const
inline

Get the field type.

This is the same as the C function OGR_FldDomain_GetFieldType().

◆ GetMergePolicy()

OGRFieldDomainMergePolicy OGRFieldDomain::GetMergePolicy ( ) const
inline

Get the merge policy.

This is the same as the C function OGR_FldDomain_GetMergePolicy().

◆ GetName()

const std::string & OGRFieldDomain::GetName ( ) const
inline

Get the name of the field domain.

This is the same as the C function OGR_FldDomain_GetName().

◆ GetSplitPolicy()

OGRFieldDomainSplitPolicy OGRFieldDomain::GetSplitPolicy ( ) const
inline

Get the split policy.

This is the same as the C function OGR_FldDomain_GetSplitPolicy().

◆ SetMergePolicy()

void OGRFieldDomain::SetMergePolicy ( OGRFieldDomainMergePolicy  policy)
inline

Set the merge policy.

This is the same as the C function OGR_FldDomain_SetMergePolicy().

◆ SetSplitPolicy()

void OGRFieldDomain::SetSplitPolicy ( OGRFieldDomainSplitPolicy  policy)
inline

Set the split policy.

This is the same as the C function OGR_FldDomain_SetSplitPolicy().


The documentation for this class was generated from the following files: