File MetadataKey.h

namespace OpenVDS

Enums

enum class MetadataType

Values:

enumerator Int

enumerator IntVector2

enumerator IntVector3

enumerator IntVector4

enumerator Float

enumerator FloatVector2

enumerator FloatVector3

enumerator FloatVector4

enumerator Double

enumerator DoubleVector2

enumerator DoubleVector3

enumerator DoubleVector4

enumerator String

enumerator BLOB

class MetadataKey

#include <MetadataKey.h>

A metadata key uniquely identifies a metadata item.

Public Functions

inline MetadataKey(): Default constructor.

inline MetadataKey(MetadataType type, const char *category, const char *name)

Constructor.

Parameters:

type – The type of the metadata that this key identifies. The possible types are (Int, Float, Double, {Int,Float,Double}Vector{2,3,4}, String or BLOB).
category – The category of the metadata that this key identifies. A category is a collection of related metadata items, e.g. SurveyCoordinateSystem consists of Origin, InlineSpacing, CrosslineSpacing and Unit metadata.
name – The name of the metadata that this key identifies

inline MetadataType GetType() const

Get the type of metadata that this key identifies.

Returns:: The type of the metadata that this key identifies

inline const char *GetCategory() const

Get the category of metadata that this key identifies.

Returns:: The category of the metadata that this key identifies

inline const char *GetName() const

Get the name of metadata that this key identifies.

Returns:: The name of the metadata that this key identifies

inline bool operator==(const MetadataKey &other) const

inline bool operator!=(const MetadataKey &other) const

Private Members

MetadataType m_type

const char *m_category

const char *m_name

class MetadataKeyRange

#include <MetadataKey.h>

A range of metadata keys that can be iterated over using range-based ‘for’.

Public Types

using const_iterator = const MetadataKey*

Public Functions

inline MetadataKeyRange(const_iterator begin, const_iterator end)

inline const_iterator begin() const: Returns a const iterator pointing to the first element in the MetadataKey collection.

inline const_iterator end() const: Returns a const iterator pointing to the past-the-end element in the MetadataKey collection.

Private Members

const MetadataKey *m_begin

const MetadataKey *m_end