witsml2_1::WellCompletion Class Reference

#include <WellCompletion.h>

Inheritance diagram for witsml2_1::WellCompletion:

Public Member Functions
	WellCompletion (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	WellCompletion (WITSML2_NS::Well *witsmlWell, const std::string &guid, const std::string &title)
	Constructor.
	WellCompletion (gsoap_eml2_3::witsml21__WellCompletion *fromGsoap)
	~WellCompletion ()=default
common::DataObjectReference	getWellDor () const
WITSML2_NS::Well *	getWell () const
void	setWell (WITSML2_NS::Well *witsmlWell)
std::vector< WellboreCompletion * >	getWellboreCompletions () const
virtual std::string	getXmlTag () const
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_TAG
static constexpr char const *	XML_NS = "witsml21"

Detailed Description

A well completion.

Constructor & Destructor Documentation

WellCompletion() [1/3]

witsml2_1::WellCompletion::WellCompletion ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out]

partialObject

If non-null, the partial object.

WellCompletion() [2/3]

witsml2_1::WellCompletion::WellCompletion	(	WITSML2_NS::Well *	witsmlWell,
		const std::string &	guid,
		const std::string &	title )

Constructor.

Exceptions

std::invalid_argument

If witsmlWell == nullptr.

Parameters

[in]	witsmlWell	If non-null, the witsml well.
	guid	Unique identifier.
	title	The title.

WellCompletion() [3/3]

witsml2_1::WellCompletion::WellCompletion ( gsoap_eml2_3::witsml21__WellCompletion * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~WellCompletion()

witsml2_1::WellCompletion::~WellCompletion ( )

default

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

Member Function Documentation

getWell()

WITSML2_NS::Well * witsml2_1::WellCompletion::getWell

(

)

const

Get the well of this well completion.

getWellboreCompletions()

std::vector< WellboreCompletion * > witsml2_1::WellCompletion::getWellboreCompletions

(

)

const

Get all welbore completions linked with this well completion.

Returns

Null if it fails, else the wellbore completions.

getWellDor()

common::DataObjectReference witsml2_1::WellCompletion::getWellDor

(

)

const

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

getXmlNamespace()

std::string witsml2_1::WellCompletion::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

getXmlTag()

virtual std::string witsml2_1::WellCompletion::getXmlTag ( ) const

inlinevirtual

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

Returns

The XML tag.

loadTargetRelationships()

void witsml2_1::WellCompletion::loadTargetRelationships ( )

final

Resolve all relationships of the object in the repository.

setWell()

void witsml2_1::WellCompletion::setWell

(

WITSML2_NS::Well *

witsmlWell

)

Set the well of this well completion.

Parameters

[in,out]

witsmlWell

If non-null, the witsml well.

Member Data Documentation

XML_NS

constexpr char const* witsml2_1::WellCompletion::XML_NS = "witsml21"

staticconstexpr

The standard XML namespace for serializing this data object.

XML_TAG

const char* witsml2_1::WellCompletion::XML_TAG

static

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:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/witsml2_1/WellCompletion.h