#include <WellboreMarker.h>

Inheritance diagram for resqml2_2::WellboreMarker:

Public Member Functions
	WellboreMarker (resqml2_2::WellboreMarkerFrameRepresentation *wellboreMarkerFrame, const std::string &guid, const std::string &title)

	WellboreMarker (resqml2_2::WellboreMarkerFrameRepresentation *wellboreMarkerFrame, const std::string &guid, const std::string &title, gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind geologicBoundaryKind)

	WellboreMarker (gsoap_eml2_3::resqml22__WellboreMarker *fromGsoap)

	~WellboreMarker ()=default

bool	hasAGeologicBoundaryKind () const final

gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind	getGeologicBoundaryKind () const final

common::DataObjectReference	getBoundaryFeatureInterpretationDor () const final

void	setBoundaryFeatureInterpretation (resqml2::BoundaryFeatureInterpretation *interp) final

void	setWitsmlWellboreMarker (witsml2_0::WellboreMarker *wellboreMarker) final

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::WellboreMarker
WellboreMarkerFrameRepresentation const *	getWellboreMarkerFrameRepresentation () const

BoundaryFeatureInterpretation *	getBoundaryFeatureInterpretation () const

witsml2_0::WellboreMarker *	getWitsmlWellboreMarker () const

bool	hasDipAngle () const

double	getDipAngleValue () const

gsoap_eml2_1::eml21__PlaneAngleUom	getDipAngleUom () const

std::string	getDipAngleUomAsString () const

bool	hasDipDirection () const

double	getDipDirectionValue () const

gsoap_eml2_1::eml21__PlaneAngleUom	getDipDirectionUom () const

std::string	getDipDirectionUomAsString () const

virtual std::string	getXmlTag () 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	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)

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_NS

Static Public Attributes inherited from resqml2::WellboreMarker
static const char *	XML_TAG

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

Proxy class for a wellbore marker. This class is one of the only one to be a RESQML data object which is not exported into a single file i.e. it is not a top level element. Consequently its behaviour is slightly different than other class. Especially there is no integration of the instances into an EPC document.

Constructor & Destructor Documentation

◆ WellboreMarker() [1/3]

resqml2_2::WellboreMarker::WellboreMarker	(	resqml2_2::WellboreMarkerFrameRepresentation *	wellboreMarkerFrame,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gSOAP context.

Exceptions

std::invalid_argument If wellboreMarkerFrame is nullptr.

Parameters

[in,out]	wellboreMarkerFrame	The wellbore marker frame representation which contains the wellbore marker to contruct. It cannot be null.
	guid	The guid to set to this wellbore marker. If empty then a new guid will be generated.
	title	The title to set to this wellbore marker. If empty then "unknown" title will be set.

◆ WellboreMarker() [2/3]

resqml2_2::WellboreMarker::WellboreMarker	(	resqml2_2::WellboreMarkerFrameRepresentation *	wellboreMarkerFrame,
		const std::string &	guid,
		const std::string &	title,
		gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind	geologicBoundaryKind
	)

Creates an instance of this class in a gSOAP context.

Exceptions

std::invalid_argument If wellboreMarkerFrame is nullptr.

Parameters

[in,out]	wellboreMarkerFrame	The wellbore marker frame representation which contains the wellbore marker to contruct. It cannot be null.
	guid	The guid to set to this wellbore marker. If empty then a new guid will be generated.
	title	The title to set to this wellbore marker. If empty then "unknown" title will be set.
	geologicBoundaryKind	The type of the feature the marker intersects.

◆ WellboreMarker() [3/3]

resqml2_2::WellboreMarker::WellboreMarker ( gsoap_eml2_3::resqml22__WellboreMarker * fromGsoap )

inline

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

Parameters

[in] fromGsoap If non-null, the gSOAP instance.

◆ ~WellboreMarker()

resqml2_2::WellboreMarker::~WellboreMarker ( )

virtualdefault

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

Reimplemented from resqml2::WellboreMarker.

Member Function Documentation

◆ getBoundaryFeatureInterpretationDor()

common::DataObjectReference resqml2_2::WellboreMarker::getBoundaryFeatureInterpretationDor ( ) const

finalvirtual

Gets the UUID of the boundary feature interpretation linked to this well marker. Especially useful in partial transfer mode.

Returns: The boundary feature interpretation UUID, or empty string if it fails.

Implements resqml2::WellboreMarker.

◆ getGeologicBoundaryKind()

gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind resqml2_2::WellboreMarker::getGeologicBoundaryKind ( ) const

finalvirtual

Gets the type of the intersected feature of the marker.

Exceptions

std::invalid_argument If the marker has no geologic boundary kind (see method hasAGeologicBoundaryKind()).

Returns: The geologic boundary kind associated to this marker.

Implements resqml2::WellboreMarker.

◆ getXmlNamespace()

std::string resqml2_2::WellboreMarker::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ hasAGeologicBoundaryKind()

bool resqml2_2::WellboreMarker::hasAGeologicBoundaryKind ( ) const

finalvirtual

Indicates if the marker is associated to a particular geologic boundary kind.

Returns: True if the marker is associated to a particular geologic boundary kind, false if not.

Implements resqml2::WellboreMarker.

◆ setBoundaryFeatureInterpretation()

void resqml2_2::WellboreMarker::setBoundaryFeatureInterpretation ( resqml2::BoundaryFeatureInterpretation * interp )

finalvirtual

Sets the boundary feature interpretation linked to this well marker.

Exceptions

std::invalid_argument If interp is nullptr.

Parameters

[in] interp The boundary feature interpretation to link to this well marker. It cannot be null.

Implements resqml2::WellboreMarker.

◆ setWitsmlWellboreMarker()

void resqml2_2::WellboreMarker::setWitsmlWellboreMarker ( witsml2_0::WellboreMarker * wellboreMarker )

finalvirtual

Sets the WITSML wellbore marker associated to this instance.

Exceptions

std::invalid_argument If the WITSML wellbore marker to set is NULL.

Parameters

[in] wellbore The WITSML wellbore marker to associate to this wellbore. It cannot be null.

Implements resqml2::WellboreMarker.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::WellboreMarker::XML_NS

static

The standard XML namespace for serializing this data object.

The documentation for this class was generated from the following file:

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2_2/WellboreMarker.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WellboreMarker() [1/3]

◆ WellboreMarker() [2/3]

◆ WellboreMarker() [3/3]

◆ ~WellboreMarker()

Member Function Documentation

◆ getBoundaryFeatureInterpretationDor()

◆ getGeologicBoundaryKind()

◆ getXmlNamespace()

◆ hasAGeologicBoundaryKind()

◆ setBoundaryFeatureInterpretation()

◆ setWitsmlWellboreMarker()

Member Data Documentation

◆ XML_NS