Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
#include <WellboreCompletion.h>
Public Types | |
enum class | WellReservoirConnectionType { PERFORATION = 0 , GRAVEL_PACK = 1 , OPEN_HOLE = 2 , SLOTS = 3 } |
Public Member Functions | |
WellboreCompletion (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
WellboreCompletion (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title) | |
WellboreCompletion (gsoap_eml2_3::witsml21__WellboreCompletion *fromGsoap) | |
~WellboreCompletion ()=default | |
common::DataObjectReference | getWellboreDor () const final |
common::DataObjectReference | getWellCompletionDor () const |
class WellCompletion * | getWellCompletion () const |
void | setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final |
void | setWellCompletion (class WellCompletion *wellCompletion) |
void | pushBackConnection (WellReservoirConnectionType wellReservoirConnection, gsoap_eml2_3::eml23__LengthUom MdUnit, double TopMd, double BaseMd, const std::string &uid) |
void | pushBackConnectionExtraMetadata (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &key, const std::string &value) |
void | pushBackConnectionHistory (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &historyGuid="") |
void | pushBackConnectionHistory (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::witsml21__PhysicalStatus staus, time_t startDate, const std::string &historyGuid="") |
uint64_t | getConnectionCount (WellReservoirConnectionType wellReservoirConnection) const |
std::string | getConnectionUid (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
std::vector< std::string > | getConnectionExtraMetadata (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &key) const |
bool | hasConnectionMdDatum (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
bool | hasConnectionMdInterval (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
gsoap_eml2_3::eml23__LengthUom | getConnectionMdUnit (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
std::string | getConnectionMdUnitAsString (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
double | getConnectionTopMd (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
double | getConnectionBaseMd (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
uint64_t | getConnectionHistoryCount (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
bool | hasConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
gsoap_eml2_3::witsml21__PhysicalStatus | getConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
std::string | getConnectionHistoryStatusToString (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
void | setConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::witsml21__PhysicalStatus connectionStatus) |
bool | hasConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
time_t | getConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
void | setConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t startDate) const |
bool | hasConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
time_t | getConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
void | setConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t endDate) const |
bool | hasConnectionHistoryMdDatum (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
bool | hasConnectionHistoryMdInterval (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
gsoap_eml2_3::eml23__LengthUom | getConnectionHistoryMdUnit (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
std::string | getConnectionHistoryMdUnitAsString (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
double | getConnectionHistoryTopMd (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
void | setConnectionHistoryMdInterval (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::eml23__LengthUom MdUnit, double TopMd, double baseMd) |
double | getConnectionHistoryBaseMd (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
bool | hasConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
std::string | getConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const |
void | setConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &comment) |
virtual std::string | getXmlTag () const |
void | loadTargetRelationships () final |
std::string | getXmlNamespace () const final |
Public Member Functions inherited from WITSML2_NS::WellboreObject | |
virtual | ~WellboreObject ()=default |
Wellbore * | getWellbore () const |
Static Public Attributes | |
static constexpr char const * | XML_TAG = "WellboreCompletion" |
static constexpr char const * | XML_NS = "witsml21" |
The location/interval of the connections between well and reservoir and its history.
|
strong |
The physical nature of a connection from reservoir to wellbore
|
inline |
Only to be used in partial transfer context
[in,out] | partialObject | If non-null, the partial object. |
witsml2_1::WellboreCompletion::WellboreCompletion | ( | WITSML2_NS::Wellbore * | witsmlWellbore, |
const std::string & | guid, | ||
const std::string & | title ) |
Constructor
[in,out] | witsmlWellbore | If non-null, the witsml wellbore. |
guid | Unique identifier. | |
title | The title. |
|
inline |
Creates an instance of this class by wrapping a gsoap instance.
[in,out] | fromGsoap | If non-null, from gsoap. |
|
default |
Destructor does nothing since the memory is managed by the gsoap context.
double witsml2_1::WellboreCompletion::getConnectionBaseMd | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Gets connection base md
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
uint64_t witsml2_1::WellboreCompletion::getConnectionCount | ( | WellReservoirConnectionType | wellReservoirConnection | ) | const |
Gets connection count of a certin type
wellReservoirConnection | The physical nature of the connections to count |
std::vector< std::string > witsml2_1::WellboreCompletion::getConnectionExtraMetadata | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex, | ||
const std::string & | key ) const |
Gets an extra metadata of a particular connection according to its key
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
key | The key of an extra metadata. |
key
(empty vector if there is no such value) in the connection at index
. double witsml2_1::WellboreCompletion::getConnectionHistoryBaseMd | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history base md
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
std::string witsml2_1::WellboreCompletion::getConnectionHistoryComment | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history comment
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
uint64_t witsml2_1::WellboreCompletion::getConnectionHistoryCount | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Gets connection history count
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
time_t witsml2_1::WellboreCompletion::getConnectionHistoryEndDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history end date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreCompletion::getConnectionHistoryMdUnit | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Returns md base uom if exists, else returns md top uom. Raises an exception if no md is defined.
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
std::string witsml2_1::WellboreCompletion::getConnectionHistoryMdUnitAsString | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Returns md base uom (as string) if exists, else returns md top uom (as string). Raises an exception if no md is defined.
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
time_t witsml2_1::WellboreCompletion::getConnectionHistoryStartDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history start date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
gsoap_eml2_3::witsml21__PhysicalStatus witsml2_1::WellboreCompletion::getConnectionHistoryStatus | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history status
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
std::string witsml2_1::WellboreCompletion::getConnectionHistoryStatusToString | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history status to string
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
double witsml2_1::WellboreCompletion::getConnectionHistoryTopMd | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Gets connection history top md
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreCompletion::getConnectionMdUnit | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Returns md base uom if exists, else returns md top uom. Raises an exception if no md is defined.
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
std::string witsml2_1::WellboreCompletion::getConnectionMdUnitAsString | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Returns md base uom (as string) if exists, else returns md top uom (as string). Raises an exception if no md is defined.
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
double witsml2_1::WellboreCompletion::getConnectionTopMd | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Gets connection top md
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
std::string witsml2_1::WellboreCompletion::getConnectionUid | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Gets the UID of the connection of a particular type at a particular index
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
|
finalvirtual |
Get the Data Object Reference of the wellbore linked with this data object.
Implements WITSML2_NS::WellboreObject.
class WellCompletion * witsml2_1::WellboreCompletion::getWellCompletion | ( | ) | const |
Get the well completion linked with this data object
common::DataObjectReference witsml2_1::WellboreCompletion::getWellCompletionDor | ( | ) | const |
Get the Data Object Reference of the well completion linked with this data object.
|
inlinefinal |
Get the standard XML namespace for serializing this data object.
|
inlinevirtual |
Get the standard XML tag without XML namespace for serializing this data object.
bool witsml2_1::WellboreCompletion::hasConnectionHistoryComment | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history comment
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
bool witsml2_1::WellboreCompletion::hasConnectionHistoryEndDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history end date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
bool witsml2_1::WellboreCompletion::hasConnectionHistoryMdDatum | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history md datum
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
bool witsml2_1::WellboreCompletion::hasConnectionHistoryMdInterval | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history MD interval
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
bool witsml2_1::WellboreCompletion::hasConnectionHistoryStartDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history start date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
bool witsml2_1::WellboreCompletion::hasConnectionHistoryStatus | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex ) const |
Query if 'historyIndex' has connection history status
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
bool witsml2_1::WellboreCompletion::hasConnectionMdDatum | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Query if 'index' has connection md datum
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
bool witsml2_1::WellboreCompletion::hasConnectionMdInterval | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex ) const |
Query if 'index' has connection Md interval
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
|
finalvirtual |
Resolve all relationships of the object in an epc document.
Reimplemented from WITSML2_NS::WellboreObject.
void witsml2_1::WellboreCompletion::pushBackConnection | ( | WellReservoirConnectionType | wellReservoirConnection, |
gsoap_eml2_3::eml23__LengthUom | MdUnit, | ||
double | TopMd, | ||
double | BaseMd, | ||
const std::string & | uid ) |
Pushes back a connection
wellReservoirConnection | The physical nature of the connection from reservoir to wellbore to add |
MdUnit | The md unit. |
TopMd | The top md. |
BaseMd | The base md. |
guid | Unique identifier of the connection. |
void witsml2_1::WellboreCompletion::pushBackConnectionExtraMetadata | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex, | ||
const std::string & | key, | ||
const std::string & | value ) |
Pushes back connection extra metadata
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
key | The key of the metadata. |
value | The value of the metadata. |
void witsml2_1::WellboreCompletion::pushBackConnectionHistory | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex, | ||
const std::string & | historyGuid = "" ) |
Pushes a back perforaconnectiontion history
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
historyGuid | (Optional) Unique identifier. |
void witsml2_1::WellboreCompletion::pushBackConnectionHistory | ( | WellReservoirConnectionType | wellReservoirConnection, |
uint64_t | connectionIndex, | ||
gsoap_eml2_3::witsml21__PhysicalStatus | staus, | ||
time_t | startDate, | ||
const std::string & | historyGuid = "" ) |
Pushes back connection history
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
status | The connection status. |
startDate | The start date. |
historyGuid | (Optional) Unique identifier. |
void witsml2_1::WellboreCompletion::setConnectionHistoryComment | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex, | ||
const std::string & | comment ) |
Sets connection history comment
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
comment | The comment. |
void witsml2_1::WellboreCompletion::setConnectionHistoryEndDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex, | ||
time_t | endDate ) const |
Sets connection history end date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
endDate | The end date. |
void witsml2_1::WellboreCompletion::setConnectionHistoryMdInterval | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex, | ||
gsoap_eml2_3::eml23__LengthUom | MdUnit, | ||
double | TopMd, | ||
double | baseMd ) |
Connection history datum is overwritten if exists. For instance if a base md is already defined.
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
MdUnit | The md unit. |
TopMd | The top md. |
BaseMd | The base md. |
void witsml2_1::WellboreCompletion::setConnectionHistoryStartDate | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex, | ||
time_t | startDate ) const |
Sets connection history start date
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | Zero-based index of the connection. |
startDate | The start date. |
void witsml2_1::WellboreCompletion::setConnectionHistoryStatus | ( | uint64_t | historyIndex, |
WellReservoirConnectionType | wellReservoirConnection, | ||
uint64_t | connectionIndex, | ||
gsoap_eml2_3::witsml21__PhysicalStatus | connectionStatus ) |
Sets connection history status
historyIndex | Zero-based index of the history. |
wellReservoirConnection | The physical nature of the connection |
connectionIndex | The index of the connection in the array of type wellReservoirConnection. |
connectionStatus | The connection status. |
|
finalvirtual |
Set the wellbore linked with this data object
[in,out] | witsmlWellbore | If non-null, the witsml wellbore. |
Implements WITSML2_NS::WellboreObject.
void witsml2_1::WellboreCompletion::setWellCompletion | ( | class WellCompletion * | wellCompletion | ) |
Set the well completion linked with this data object
[in,out] | wellCompletion | If non-null, the well completion. |
|
staticconstexpr |
The standard XML namespace for serializing this data object.
|
staticconstexpr |
The standard XML tag without XML namespace for serializing this data object.