Fesapi 2.10.1.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
witsml2_1::WellCompletion Class Reference

#include <WellCompletion.h>

Inheritance diagram for witsml2_1::WellCompletion:
common::AbstractObject

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::WellgetWell () 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
 
- 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)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_3::eml23__DataObjectReference * newEml23Reference () const
 
gsoap_resqml2_0_1::resqml20__ContactElementReference * newContactElementReference2_0_1 () const
 
gsoap_eml2_3::resqml22__ContactElement * newContactElementReference2_2 () const
 
common::DataObjectRepositorygetRepository () const
 
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)
 
uint64_t getAliasCount () const
 
std::string getAliasAuthorityAtIndex (uint64_t index) const
 
std::string getAliasTitleAtIndex (uint64_t index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
uint64_t getActivityCount () const
 
eml2::ActivitygetActivity (uint64_t 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
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 

Static Public Attributes

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

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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

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]partialObjectIf 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_argumentIf witsmlWell == nullptr.
Parameters
[in]witsmlWellIf non-null, the witsml well.
guidUnique identifier.
titleThe 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]fromGsoapIf 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
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

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

Implements common::AbstractObject.

◆ loadTargetRelationships()

void witsml2_1::WellCompletion::loadTargetRelationships ( )
finalvirtual

Resolve all relationships of the object in the repository.

Implements common::AbstractObject.

◆ setWell()

void witsml2_1::WellCompletion::setWell ( WITSML2_NS::Well * witsmlWell)

Set the well of this well completion.

Parameters
[in,out]witsmlWellIf non-null, the witsml well.

Member Data Documentation

◆ XML_NS

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: