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

#include <WellboreMarker.h>

Inheritance diagram for witsml2_0::WellboreMarker:
witsml2_0::WellboreObject witsml2_0::AbstractObject WITSML2_NS::AbstractObject common::AbstractObject

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_1::eml21__LengthUom mdUom, const std::string &mdDatum)
 Constructor. More...
 
 WellboreMarker (Wellbore *witsmlWellbore, const std::string &guid, const std::string &title, double md, gsoap_eml2_1::eml21__LengthUom mdUom, const std::string &mdDatum)
 Constructor. More...
 
 WellboreMarker (gsoap_eml2_1::witsml20__WellboreMarker *fromGsoap)
 
 ~WellboreMarker ()=default
 
common::DataObjectReference getWellboreDor () const
 
void setWellbore (Wellbore *witsmlWellbore)
 
virtual std::string getXmlTag () const
 
- Public Member Functions inherited from witsml2_0::WellboreObject
virtual ~WellboreObject ()=default
 
WellboregetWellbore () const
 
virtual void loadTargetRelationships ()
 
- 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::DataObjectRepositorygetRepository () 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::ActivitygetActivity (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)
 

Detailed Description

A WellboreMarker.

Constructor & Destructor Documentation

◆ WellboreMarker() [1/4]

witsml2_0::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_0::WellboreMarker::WellboreMarker ( common::DataObjectRepository repo,
const std::string &  guid,
const std::string &  title,
double  md,
gsoap_eml2_1::eml21__LengthUom  mdUom,
const std::string &  mdDatum 
)

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.
mdDatumA free string to unformally indicate the datum of the MD (i.e. where MD==0).

◆ WellboreMarker() [3/4]

witsml2_0::WellboreMarker::WellboreMarker ( Wellbore witsmlWellbore,
const std::string &  guid,
const std::string &  title,
double  md,
gsoap_eml2_1::eml21__LengthUom  mdUom,
const std::string &  mdDatum 
)

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.
mdDatumA free string to unformally indicate the datum of the MD (i.e. where MD==0).

◆ WellboreMarker() [4/4]

witsml2_0::WellboreMarker::WellboreMarker ( gsoap_eml2_1::witsml20__WellboreMarker *  fromGsoap)
inline

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

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

◆ ~WellboreMarker()

witsml2_0::WellboreMarker::~WellboreMarker ( )
default

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

Member Function Documentation

◆ getWellboreDor()

common::DataObjectReference witsml2_0::WellboreMarker::getWellboreDor ( ) const
virtual

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

Implements witsml2_0::WellboreObject.

◆ getXmlTag()

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

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

Returns
The XML tag.

Implements common::AbstractObject.

◆ setWellbore()

void witsml2_0::WellboreMarker::setWellbore ( Wellbore witsmlWellbore)
virtual

Set the wellbore linked with this data object.

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

Implements witsml2_0::WellboreObject.

Member Data Documentation

◆ XML_TAG

const char* witsml2_0::WellboreMarker::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: