Fesapi
2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
#include <WellboreCompletion.h>
Public Member Functions | |
WellboreCompletion (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
WellboreCompletion (class Wellbore *witsmlWellbore, class WellCompletion *wellCompletion, const std::string &guid, const std::string &title, const std::string &wellCompletionName) | |
WellboreCompletion (gsoap_eml2_1::witsml20__WellboreCompletion *fromGsoap) | |
~WellboreCompletion ()=default | |
common::DataObjectReference | getWellboreDor () const |
common::DataObjectReference | getWellCompletionDor () const |
class WellCompletion * | getWellCompletion () const |
void | setWellbore (class Wellbore *witsmlWellbore) |
void | setWellCompletion (class WellCompletion *wellCompletion) |
void | pushBackPerforation (const std::string &datum, gsoap_eml2_1::eml21__LengthUom MdUnit, double TopMd, double BaseMd, const std::string &guid="") |
void | pushBackPerforationHistory (unsigned int index, const std::string &guid="") |
void | pushBackPerforationHistory (unsigned int index, gsoap_eml2_1::witsml20__PerforationStatus perforationStatus, time_t startDate, const std::string &guid="") |
unsigned int | getPerforationCount () const |
std::string | getPerforationUid (unsigned int index) const |
bool | hasPerforationMdDatum (unsigned int index) const |
std::string | getPerforationMdDatum (unsigned int index) const |
bool | hasPerforationMdUnit (unsigned int index) const |
gsoap_eml2_1::eml21__LengthUom | getPerforationMdUnit (unsigned int index) const |
std::string | getPerforationMdUnitAsString (unsigned int index) const |
bool | hasPerforationTopMd (unsigned int index) const |
double | getPerforationTopMd (unsigned int index) const |
bool | hasPerforationBaseMd (unsigned int index) const |
double | getPerforationBaseMd (unsigned int index) const |
unsigned int | getPerforationHistoryCount (unsigned int index) const |
bool | hasPerforationHistoryStatus (unsigned int historyIndex, unsigned int perforationIndex) const |
gsoap_eml2_1::witsml20__PerforationStatus | getPerforationHistoryStatus (unsigned int historyIndex, unsigned int perforationIndex) const |
std::string | getPerforationHistoryStatusToString (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryStatus (unsigned int historyIndex, unsigned int perforationIndex, gsoap_eml2_1::witsml20__PerforationStatus perforationStatus) |
bool | hasPerforationHistoryStartDate (unsigned int historyIndex, unsigned int perforationIndex) const |
time_t | getPerforationHistoryStartDate (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryStartDate (unsigned int historyIndex, unsigned int perforationIndex, time_t startDate) const |
bool | hasPerforationHistoryEndDate (unsigned int historyIndex, unsigned int perforationIndex) const |
time_t | getPerforationHistoryEndDate (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryEndDate (unsigned int historyIndex, unsigned int perforationIndex, time_t endDate) const |
bool | hasPerforationHistoryMdDatum (unsigned int historyIndex, unsigned int perforationIndex) const |
std::string | getPerforationHistoryMdDatum (unsigned int historyIndex, unsigned int perforationIndex) const |
bool | hasPerforationHistoryMdUnit (unsigned int historyIndex, unsigned int perforationIndex) const |
gsoap_eml2_1::eml21__LengthUom | getPerforationHistoryMdUnit (unsigned int historyIndex, unsigned int perforationIndex) const |
std::string | getPerforationHistoryMdUnitAsString (unsigned int historyIndex, unsigned int perforationIndex) const |
bool | hasPerforationHistoryTopMd (unsigned int historyIndex, unsigned int perforationIndex) const |
double | getPerforationHistoryTopMd (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryTopMd (unsigned int historyIndex, unsigned int perforationIndex, const std::string &datum, gsoap_eml2_1::eml21__LengthUom MdUnit, double TopMd) |
bool | hasPerforationHistoryBaseMd (unsigned int historyIndex, unsigned int perforationIndex) const |
double | getPerforationHistoryBaseMd (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryBaseMd (unsigned int historyIndex, unsigned int perforationIndex, const std::string &datum, gsoap_eml2_1::eml21__LengthUom MdUnit, double BaseMd) |
bool | hasPerforationHistoryComment (unsigned int historyIndex, unsigned int perforationIndex) const |
std::string | getPerforationHistoryComment (unsigned int historyIndex, unsigned int perforationIndex) const |
void | setPerforationHistoryComment (unsigned int historyIndex, unsigned int perforationIndex, const std::string &comment) |
virtual std::string | getXmlTag () const |
void | loadTargetRelationships () |
Public Member Functions inherited from witsml2_0::WellboreObject | |
virtual | ~WellboreObject ()=default |
Wellbore * | getWellbore () const |
Public Member Functions inherited from witsml2_0::AbstractObject | |
virtual | ~AbstractObject ()=default |
std::string | getContentType () const |
std::string | getPartNameInEpcDocument () const |
std::string | getXmlNamespace () 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 | getXmlNamespaceVersion () const |
virtual std::string | getQualifiedType () 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 |
Static Public Attributes | |
static const char * | XML_TAG |
Static Public Attributes inherited from witsml2_0::AbstractObject | |
static const char * | XML_NS |
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) |
The location/interval of the perforation set and its history.
|
inline |
Only to be used in partial transfer context
[in,out] | partialObject | If non-null, the partial object. |
witsml2_0::WellboreCompletion::WellboreCompletion | ( | class Wellbore * | witsmlWellbore, |
class WellCompletion * | wellCompletion, | ||
const std::string & | guid, | ||
const std::string & | title, | ||
const std::string & | wellCompletionName | ||
) |
Constructor
[in,out] | witsmlWellbore | If non-null, the witsml wellbore. |
[in,out] | wellCompletion | If non-null, the well completion. |
guid | Unique identifier. | |
title | The title. | |
wellCompletionName | Name of the well completion. |
|
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_0::WellboreCompletion::getPerforationBaseMd | ( | unsigned int | index | ) | const |
Gets perforation base md
index | Zero-based index of the. |
unsigned int witsml2_0::WellboreCompletion::getPerforationCount | ( | ) | const |
Gets perforation count
double witsml2_0::WellboreCompletion::getPerforationHistoryBaseMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history base md
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
std::string witsml2_0::WellboreCompletion::getPerforationHistoryComment | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history comment
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
unsigned int witsml2_0::WellboreCompletion::getPerforationHistoryCount | ( | unsigned int | index | ) | const |
Gets perforation history count
index | Zero-based index of the. |
time_t witsml2_0::WellboreCompletion::getPerforationHistoryEndDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history end date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
std::string witsml2_0::WellboreCompletion::getPerforationHistoryMdDatum | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history md datum
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
gsoap_eml2_1::eml21__LengthUom witsml2_0::WellboreCompletion::getPerforationHistoryMdUnit | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | 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. |
perforationIndex | Zero-based index of the perforation. |
std::string witsml2_0::WellboreCompletion::getPerforationHistoryMdUnitAsString | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | 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. |
perforationIndex | Zero-based index of the perforation. |
time_t witsml2_0::WellboreCompletion::getPerforationHistoryStartDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history start date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
gsoap_eml2_1::witsml20__PerforationStatus witsml2_0::WellboreCompletion::getPerforationHistoryStatus | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history status
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
std::string witsml2_0::WellboreCompletion::getPerforationHistoryStatusToString | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history status to string
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
double witsml2_0::WellboreCompletion::getPerforationHistoryTopMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Gets perforation history top md
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
std::string witsml2_0::WellboreCompletion::getPerforationMdDatum | ( | unsigned int | index | ) | const |
Gets perforation md datum
index | Zero-based index of the. |
gsoap_eml2_1::eml21__LengthUom witsml2_0::WellboreCompletion::getPerforationMdUnit | ( | unsigned int | index | ) | const |
Returns md base uom if exists, else returns md top uom. Raises an exception if no md is defined.
index | Zero-based index of the. |
std::string witsml2_0::WellboreCompletion::getPerforationMdUnitAsString | ( | unsigned int | index | ) | const |
Returns md base uom (as string) if exists, else returns md top uom (as string). Raises an exception if no md is defined.
index | Zero-based index of the. |
double witsml2_0::WellboreCompletion::getPerforationTopMd | ( | unsigned int | index | ) | const |
Gets perforation top md
index | Zero-based index of the. |
std::string witsml2_0::WellboreCompletion::getPerforationUid | ( | unsigned int | index | ) | const |
Gets perforation UID
index | Zero-based index of the. |
|
virtual |
Get the Data Object Reference of the wellbore linked with this data object.
Implements witsml2_0::WellboreObject.
class WellCompletion* witsml2_0::WellboreCompletion::getWellCompletion | ( | ) | const |
Get the well completion linked with this data object
common::DataObjectReference witsml2_0::WellboreCompletion::getWellCompletionDor | ( | ) | const |
Get the Data Object Reference of the well completion linked with this data object.
|
inlinevirtual |
Get the standard XML tag without XML namespace for serializing this data object.
Implements common::AbstractObject.
bool witsml2_0::WellboreCompletion::hasPerforationBaseMd | ( | unsigned int | index | ) | const |
Query if 'index' has perforation base md
index | Zero-based index of the. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryBaseMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history base md
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryComment | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history comment
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryEndDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history end date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryMdDatum | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history md datum
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryMdUnit | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history md unit
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryStartDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history start date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryStatus | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history status
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationHistoryTopMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex | ||
) | const |
Query if 'historyIndex' has perforation history top md
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
bool witsml2_0::WellboreCompletion::hasPerforationMdDatum | ( | unsigned int | index | ) | const |
Query if 'index' has perforation md datum
index | Zero-based index of the. |
bool witsml2_0::WellboreCompletion::hasPerforationMdUnit | ( | unsigned int | index | ) | const |
Query if 'index' has perforation md unit
index | Zero-based index of the. |
bool witsml2_0::WellboreCompletion::hasPerforationTopMd | ( | unsigned int | index | ) | const |
Query if 'index' has perforation top md
index | Zero-based index of the. |
|
virtual |
Resolve all relationships of the object in an epc document.
Reimplemented from witsml2_0::WellboreObject.
void witsml2_0::WellboreCompletion::pushBackPerforation | ( | const std::string & | datum, |
gsoap_eml2_1::eml21__LengthUom | MdUnit, | ||
double | TopMd, | ||
double | BaseMd, | ||
const std::string & | guid = "" |
||
) |
Pushes a back perforation
datum | The datum. |
MdUnit | The md unit. |
TopMd | The top md. |
BaseMd | The base md. |
guid | (Optional) Unique identifier. |
void witsml2_0::WellboreCompletion::pushBackPerforationHistory | ( | unsigned int | index, |
const std::string & | guid = "" |
||
) |
Pushes a back perforation history
index | Zero-based index of the. |
guid | (Optional) Unique identifier. |
void witsml2_0::WellboreCompletion::pushBackPerforationHistory | ( | unsigned int | index, |
gsoap_eml2_1::witsml20__PerforationStatus | perforationStatus, | ||
time_t | startDate, | ||
const std::string & | guid = "" |
||
) |
Pushes a back perforation history
index | Zero-based index of the. |
perforationStatus | The perforation status. |
startDate | The start date. |
guid | (Optional) Unique identifier. |
void witsml2_0::WellboreCompletion::setPerforationHistoryBaseMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
const std::string & | datum, | ||
gsoap_eml2_1::eml21__LengthUom | MdUnit, | ||
double | BaseMd | ||
) |
Perforation history datum is overwritten if exists. For instance if a top md is already defined.
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
datum | The datum. |
MdUnit | The md unit. |
BaseMd | The base md. |
void witsml2_0::WellboreCompletion::setPerforationHistoryComment | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
const std::string & | comment | ||
) |
Sets perforation history comment
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
comment | The comment. |
void witsml2_0::WellboreCompletion::setPerforationHistoryEndDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
time_t | endDate | ||
) | const |
Sets perforation history end date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
endDate | The end date. |
void witsml2_0::WellboreCompletion::setPerforationHistoryStartDate | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
time_t | startDate | ||
) | const |
Sets perforation history start date
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
startDate | The start date. |
void witsml2_0::WellboreCompletion::setPerforationHistoryStatus | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
gsoap_eml2_1::witsml20__PerforationStatus | perforationStatus | ||
) |
Sets perforation history status
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
perforationStatus | The perforation status. |
void witsml2_0::WellboreCompletion::setPerforationHistoryTopMd | ( | unsigned int | historyIndex, |
unsigned int | perforationIndex, | ||
const std::string & | datum, | ||
gsoap_eml2_1::eml21__LengthUom | MdUnit, | ||
double | TopMd | ||
) |
Perforation history datum is overwritten if exists. For instance if a base md is already defined.
historyIndex | Zero-based index of the history. |
perforationIndex | Zero-based index of the perforation. |
datum | The datum. |
MdUnit | The md unit. |
TopMd | The top md. |
|
virtual |
Set the wellbore linked with this data object
[in,out] | witsmlWellbore | If non-null, the witsml wellbore. |
Implements witsml2_0::WellboreObject.
void witsml2_0::WellboreCompletion::setWellCompletion | ( | class WellCompletion * | wellCompletion | ) |
Set the well completion linked with this data object
[in,out] | wellCompletion | If non-null, the well completion. |
|
static |
The standard XML tag without XML namespace for serializing this data object.