Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
witsml2_1::WellboreMarker Class Reference

#include <WellboreMarker.h>

Inheritance diagram for witsml2_1::WellboreMarker:
WITSML2_NS::WellboreObject

Public Member Functions

 WellboreMarker (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 WellboreMarker (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, double md, gsoap_eml2_3::eml23__LengthUom mdUom)
 Constructor.
 
 WellboreMarker (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title, double md, gsoap_eml2_3::eml23__LengthUom mdUom)
 Constructor.
 
 WellboreMarker (gsoap_eml2_3::witsml21__WellboreMarker *fromGsoap)
 
 ~WellboreMarker ()=default
 
common::DataObjectReference getWellboreDor () const final
 
void setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
 
virtual std::string getXmlTag () const
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual ~WellboreObject ()=default
 
WellboregetWellbore () const
 
virtual void loadTargetRelationships () override
 

Static Public Attributes

static constexpr char const * XML_TAG = "WellboreMarker"
 
static constexpr char const * XML_NS = "witsml21"
 

Detailed Description

A WellboreMarker.

Constructor & Destructor Documentation

◆ WellboreMarker() [1/4]

witsml2_1::WellboreMarker::WellboreMarker ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Constructor for partial transfer

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ WellboreMarker() [2/4]

witsml2_1::WellboreMarker::WellboreMarker ( common ::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
double md,
gsoap_eml2_3::eml23__LengthUom mdUom )

Constructor.

Exceptions
std::invalid_argumentIf repo == nullptr.
Parameters
[in,out]repoThe repo where the underlying gsoap proxy is going to be created.
guidUnique identifier.
titleThe title.
mdThe Measured Depth to set to this marker.
mdUomThe underlying unit of measure of the MD value.

◆ WellboreMarker() [3/4]

witsml2_1::WellboreMarker::WellboreMarker ( WITSML2_NS::Wellbore * witsmlWellbore,
const std::string & guid,
const std::string & title,
double md,
gsoap_eml2_3::eml23__LengthUom mdUom )

Constructor.

Exceptions
std::invalid_argumentIf witsmlWellbore == nullptr.
Parameters
[in]witsmlWellboreIf non-null, the witsml wellbore.
guidUnique identifier.
titleThe title.
mdThe Measured Depth to set to this marker.
mdUomThe underlying unit of measure of the MD value.

◆ WellboreMarker() [4/4]

witsml2_1::WellboreMarker::WellboreMarker ( gsoap_eml2_3::witsml21__WellboreMarker * fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~WellboreMarker()

witsml2_1::WellboreMarker::~WellboreMarker ( )
default

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

Member Function Documentation

◆ getWellboreDor()

common::DataObjectReference witsml2_1::WellboreMarker::getWellboreDor ( ) const
finalvirtual

Get the Data Object Reference of the wellbore linked with this data object.

Implements WITSML2_NS::WellboreObject.

◆ getXmlNamespace()

std::string witsml2_1::WellboreMarker::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ getXmlTag()

virtual std::string witsml2_1::WellboreMarker::getXmlTag ( ) const
inlinevirtual

Get the standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

◆ setWellbore()

void witsml2_1::WellboreMarker::setWellbore ( WITSML2_NS::Wellbore * witsmlWellbore)
finalvirtual

Set the wellbore linked with this data object.

Parameters
[in,out]witsmlWellboreIf non-null, the witsml wellbore.

Implements WITSML2_NS::WellboreObject.

Member Data Documentation

◆ XML_NS

constexpr char const* witsml2_1::WellboreMarker::XML_NS = "witsml21"
staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

constexpr char const* witsml2_1::WellboreMarker::XML_TAG = "WellboreMarker"
staticconstexpr

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

Returns
The XML tag.

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