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 | List of all members
witsml2_0::WellboreObject Class Referenceabstract

#include <WellboreObject.h>

Inheritance diagram for witsml2_0::WellboreObject:
witsml2_0::AbstractObject WITSML2_NS::AbstractObject common::AbstractObject witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Channel > witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Log > witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__ChannelSet > witsml2_0::ChannelMetaDataObject< T > witsml2_0::Trajectory witsml2_0::WellboreCompletion witsml2_0::WellboreGeometry witsml2_0::WellboreMarker

Public Member Functions

virtual ~WellboreObject ()=default
 
virtual common::DataObjectReference getWellboreDor () const =0
 
Wellbore * getWellbore () const
 
virtual void setWellbore (Wellbore *witsmlWellbore)=0
 
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::DataObjectRepository * getRepository () const
 
virtual std::string getXmlTag () const =0
 
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
 

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)
 
- Static Public Attributes inherited from witsml2_0::AbstractObject
static const char * XML_NS
 

Detailed Description

The class is the super class for all wellbore objects (all top level objects pointing to Wellbore)

Constructor & Destructor Documentation

◆ ~WellboreObject()

virtual witsml2_0::WellboreObject::~WellboreObject ( )
virtualdefault

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

Member Function Documentation

◆ getWellbore()

Wellbore* witsml2_0::WellboreObject::getWellbore ( ) const

Get the wellbore linked with this data object.

Returns
Null if it fails, else the wellbore.

◆ getWellboreDor()

virtual common::DataObjectReference witsml2_0::WellboreObject::getWellboreDor ( ) const
pure virtual

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

Implemented in witsml2_0::WellboreMarker, witsml2_0::WellboreGeometry, witsml2_0::WellboreCompletion, witsml2_0::Trajectory, witsml2_0::ChannelMetaDataObject< T >, witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Channel >, witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Log >, and witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__ChannelSet >.

◆ loadTargetRelationships()

virtual void witsml2_0::WellboreObject::loadTargetRelationships ( )
virtual

Resolve all relationships of the object in a repository.

Implements common::AbstractObject.

Reimplemented in witsml2_0::WellboreCompletion, witsml2_0::Log, witsml2_0::ChannelSet, and witsml2_0::Channel.

◆ setWellbore()

virtual void witsml2_0::WellboreObject::setWellbore ( Wellbore *  witsmlWellbore)
pure virtual

Set the wellbore linked with this data object.

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

Implemented in witsml2_0::WellboreMarker, witsml2_0::ChannelMetaDataObject< T >, witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Channel >, witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__Log >, witsml2_0::ChannelMetaDataObject< gsoap_eml2_1::witsml20__ChannelSet >, witsml2_0::WellboreGeometry, witsml2_0::WellboreCompletion, and witsml2_0::Trajectory.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.0