resqml2::MdDatum Class Reference

Proxy class for a MD datum. An MD datum specifies the location of the measured depth = 0 reference point. The location of this reference point is defined with respect to a CRS, which need not be the same as the CRS of a wellbore trajectory representation, which may reference this location. More...

#include <MdDatum.h>

Inheritance diagram for resqml2::MdDatum:

Public Member Functions
	MdDatum (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
virtual	~MdDatum ()=default
class AbstractLocal3dCrs *	getLocalCrs () const
virtual common::DataObjectReference	getLocalCrsDor () const =0
virtual double	getX () const =0
double	getXInGlobalCrs () const
virtual double	getY () const =0
double	getYInGlobalCrs () const
virtual double	getZ () const =0
double	getZInGlobalCrs () const
virtual bool	hasKind () const =0
virtual gsoap_eml2_3::eml23__ReferencePointKind	getKind () const =0
virtual std::string	getXmlTag () const final

Static Public Attributes
static const char *	XML_TAG

Detailed Description

Proxy class for a MD datum. An MD datum specifies the location of the measured depth = 0 reference point. The location of this reference point is defined with respect to a CRS, which need not be the same as the CRS of a wellbore trajectory representation, which may reference this location.

Constructor & Destructor Documentation

MdDatum()

resqml2::MdDatum::MdDatum ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in]

partialObject

If non-nullptr, the partial object.

~MdDatum()

virtual resqml2::MdDatum::~MdDatum ( )

virtualdefault

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

getKind()

virtual gsoap_eml2_3::eml23__ReferencePointKind resqml2::MdDatum::getKind ( ) const

pure virtual

Gets the origin kind of this MD datum.

Returns

The origin kind.

getLocalCrs()

class AbstractLocal3dCrs * resqml2::MdDatum::getLocalCrs

(

)

const

Gets the local 3d CRS where the reference point ordinals are given.

Exceptions

std::invalid_argument

If the local CRS is not set.

Returns

A pointer to the local CRS.

getLocalCrsDor()

virtual common::DataObjectReference resqml2::MdDatum::getLocalCrsDor ( ) const

pure virtual

Gets the data object reference of the local 3d CRS where the reference point ordinals are given.

Returns

nullptr if the local 3d CRS is not set, else the data object reference of the local 3d CRS.

getX()

virtual double resqml2::MdDatum::getX ( ) const

pure virtual

Gets the first ordinal (x) of the location of the MD reference point relative to the local CRS.

Returns

The first ordinal of the reference location relative to the local CRS.

getXInGlobalCrs()

double resqml2::MdDatum::getXInGlobalCrs

(

)

const

Gets the first ordinal (x) of the location of the MD reference in the global CRS.

Exceptions

std::invalid_argument

If the local CRS is not set.

Returns

The first ordinal of the reference location relative to the global CRS.

getXmlTag()

virtual std::string resqml2::MdDatum::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object

Returns

The XML tag.

getY()

virtual double resqml2::MdDatum::getY ( ) const

pure virtual

Gets the second ordinal (y) of the location of the MD reference point relative to the local CRS.

Returns

The second ordinal of the reference location relative to the local CRS.

getYInGlobalCrs()

double resqml2::MdDatum::getYInGlobalCrs

(

)

const

Gets the second ordinal (y) of the location of the MD reference in the global CRS.

Exceptions

std::invalid_argument

If the local CRS is not set.

Returns

The second ordinal of the reference location relative to the global CRS.

getZ()

virtual double resqml2::MdDatum::getZ ( ) const

pure virtual

Gets the third ordinal (z) of the location of the MD reference point relative to the local CRS.

Returns

The third ordinal of the reference location relative to the local CRS.

getZInGlobalCrs()

double resqml2::MdDatum::getZInGlobalCrs

(

)

const

Gets the third ordinal (z) of the location of the MD reference in the global CRS.

Exceptions

std::invalid_argument

If the local CRS is not set.

Returns

The third ordinal of the reference location relative to the global CRS.

hasKind()

virtual bool resqml2::MdDatum::hasKind ( ) const

pure virtual

Check if this reference point has a defined kind.

Returns

True if this reference point has a defined kind.

Member Data Documentation

XML_TAG

const char* resqml2::MdDatum::XML_TAG

static

The standard XML tag without XML namespace for serializing this data object

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2/MdDatum.h