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 gsoap_eml2_3::eml23__WellboreDatumReference	getOriginKind () const =0

virtual std::string	getXmlTag () const final

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

virtual void	loadTargetRelationships ()=0

Static Public Attributes
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

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.

Reimplemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

Member Function Documentation

◆ 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.

Implemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

◆ getOriginKind()

virtual gsoap_eml2_3::eml23__WellboreDatumReference resqml2::MdDatum::getOriginKind ( ) const

pure virtual

Gets the origin kind of this MD datum.

Returns: The origin kind.

Implemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

◆ 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.

Implemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

◆ 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.

Implements common::AbstractObject.

◆ 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.

Implemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

◆ 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.

Implemented in resqml2_2::MdDatum, and resqml2_0_1::MdDatum.

◆ 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.

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.0.0.0/src/resqml2/MdDatum.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MdDatum()

◆ ~MdDatum()

Member Function Documentation

◆ getLocalCrs()

◆ getLocalCrsDor()

◆ getOriginKind()

◆ getX()

◆ getXInGlobalCrs()

◆ getXmlTag()

◆ getY()

◆ getYInGlobalCrs()

◆ getZ()

◆ getZInGlobalCrs()

Member Data Documentation

◆ XML_TAG