duckdb::CoordinateReferenceSystem Class Reference

Collaboration diagram for duckdb::CoordinateReferenceSystem:

Public Member Functions
	CoordinateReferenceSystem (const string &definition)
CoordinateReferenceSystemType	GetType () const
	Get the identified type of the coordinate reference system.
const string &	GetDefinition () const
	Get the full provided definition of the coordinate reference system.
const string &	GetIdentifier () const
bool	IsComplete () const
	Is this a fully-defined coordinate system?
bool	Equals (const CoordinateReferenceSystem &other) const
void	Serialize (Serializer &serializer) const
	Serialize this CRS to a binary format.

Static Public Member Functions
static unique_ptr< CoordinateReferenceSystem >	TryIdentify (ClientContext &context, const string &source_crs)
static unique_ptr< CoordinateReferenceSystem >	TryConvert (ClientContext &context, const CoordinateReferenceSystem &source_crs, CoordinateReferenceSystemType target_type)
static unique_ptr< CoordinateReferenceSystem >	TryConvert (ClientContext &context, const string &source_crs, CoordinateReferenceSystemType target_type)
static CoordinateReferenceSystem	Deserialize (Deserializer &deserializer)
	Deserialize a CRS from a binary format.

Static Private Member Functions
static void	ParseDefinition (const string &text, CoordinateReferenceSystem &result)
static bool	TryParseAuthCode (const string &text, CoordinateReferenceSystem &result)
static bool	TryParseWKT2 (const string &text, CoordinateReferenceSystem &result)
static bool	TryParsePROJJSON (const string &text, CoordinateReferenceSystem &result)

Private Attributes
CoordinateReferenceSystemType	type = CoordinateReferenceSystemType::INVALID
	The type of the coordinate reference system.
string	definition
string	identifier

Friends
class	CoordinateReferenceSystemProvider

Constructor & Destructor Documentation

CoordinateReferenceSystem()

duckdb::CoordinateReferenceSystem::CoordinateReferenceSystem ( const string &  definition )

inlineexplicit

                                                                 {
        ParseDefinition(definition, *this);
    }

Member Function Documentation

GetType()

CoordinateReferenceSystemType duckdb::CoordinateReferenceSystem::GetType ( ) const

inline

Get the identified type of the coordinate reference system.

                                                  {
        return type;
    }

Here is the caller graph for this function:

GetDefinition()

const string & duckdb::CoordinateReferenceSystem::GetDefinition ( ) const

inline

Get the full provided definition of the coordinate reference system.

                                        {
        return definition;
    }

GetIdentifier()

const string & duckdb::CoordinateReferenceSystem::GetIdentifier ( ) const

inline

Get the "identifier" of the coordinate reference system (e.g. "EPSG:4326") This is the same as the definition for AUTH:CODE and SRID types

                                        {
        return identifier.empty() ? definition : identifier;
    }

IsComplete()

bool duckdb::CoordinateReferenceSystem::IsComplete ( ) const

inline

Is this a fully-defined coordinate system?

                            {
        switch (GetType()) {
        case CoordinateReferenceSystemType::PROJJSON:
        case CoordinateReferenceSystemType::WKT2_2019:
            return true;
        default:
            return false;
        }
    }

Here is the call graph for this function:

Equals()

bool duckdb::CoordinateReferenceSystem::Equals ( const CoordinateReferenceSystem &  other ) const

inline

Attempt to determine if this CRS is equivalent to another CRS This is currently not very precise, and may yield false negatives We consider two CRSs equal if one of the following is true:

• Their identifiers match
• Their type and full text definitions match, character-for-character

                                                              {
        // Whatever the definitions are, if the identifiers match we consider them equal
        if (!identifier.empty() && identifier == other.identifier) {
            return true;
        }
 
        // Fall back to comparing the full definitions
        // This is not ideal, because the same CRS (in the same format!) can often be expressed in multiple ways
        // E.g. field order, whitespace differences, casing, etc. But it's better than nothing for now.
 
        // In the future we should:
        // 1. Implement proper normalization for each CRS format, and make _structured_ comparisons
        // 2. Allow extensions to inject a CRS handling library (e.g. PROJ) to perform proper _semantic_ comparisons
        return type == other.type && definition == other.definition;
    }

TryIdentify()

static unique_ptr< CoordinateReferenceSystem > duckdb::CoordinateReferenceSystem::TryIdentify ( ClientContext &  context, const string &  source_crs  )

static

Try to identify a CRS from a string If the string is unable to be identified as one of the registered coordinates systems, and

• IS NOT a complete CRS definition, returns nullptr
• IS a complete CRS definition (e.g. PROJJSON or WKT2), returns the CRS as is. Otherwise, returns the identified CRS in the most compact form possible (AUTH:CODE > SRID > PROJJSON > WKT2)

TryConvert() [1/2]

static unique_ptr< CoordinateReferenceSystem > duckdb::CoordinateReferenceSystem::TryConvert ( ClientContext &  context, const CoordinateReferenceSystem &  source_crs, CoordinateReferenceSystemType  target_type  )

static

Try to convert the CRS to another format Returns nullptr if no conversion could be performed

TryConvert() [2/2]

static unique_ptr< CoordinateReferenceSystem > duckdb::CoordinateReferenceSystem::TryConvert ( ClientContext &  context, const string &  source_crs, CoordinateReferenceSystemType  target_type  )

static

Try to convert the CRS to another format Returns nullptr if no conversion could be performed

Member Data Documentation

definition

string duckdb::CoordinateReferenceSystem::definition

private

The text definition of the coordinate reference system E.g. "AUTH:CODE", or a PROJJSON or WKT2 string

identifier

string duckdb::CoordinateReferenceSystem::identifier

private

The identifier code of the coordinate reference system This can usually be derived from the text definition, but is cached here for convenience

---

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

• external/duckdb/duckdb.cpp