#include <WellboreMarker.h>

Inheritance diagram for resqml2_0_1::WellboreMarker:

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

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

	WellboreMarker (gsoap_resqml2_0_1::resqml2__WellboreMarker fromGsoap, class WellboreMarkerFrameRepresentation wellboreMarkerFrame)

	~WellboreMarker ()

bool	hasAGeologicBoundaryKind ()

gsoap_resqml2_0_1::resqml2__GeologicBoundaryKind	getGeologicBoundaryKind ()

class WellboreMarkerFrameRepresentation *	getWellMarkerFrameRepresentation ()

class BoundaryFeatureInterpretation *	getBoundaryFeatureInterpretation () const

std::string	getBoundaryFeatureInterpretationUuid () const

void	setBoundaryFeatureInterpretation (class BoundaryFeatureInterpretation *interp)

virtual std::string	getXmlTag () const

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (const time_t &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (const time_t &lastUpdate)

void	setFormat (const std::string &format)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getGsoapProxy () const

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_resqml2_0_1::resqml2__ContactElementReference *	newResqmlContactElementReference () const

common::EpcDocument *	getEpcDocument () const

virtual std::string	getXmlNamespace () const

virtual std::string	getResqmlVersion () const

virtual std::string	getContentType () 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 (const unsigned int &index) const

std::string	getAliasTitleAtIndex (const unsigned int &index) const

const std::vector< resqml2::Activity * > &	getActivitySet () const

unsigned int	getActivityCount () const

resqml2::Activity *	getActivity (const unsigned int &index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::tr1::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 (const unsigned int &index) const

std::string	getExtraMetadataStringValueAtIndex (const unsigned int &index) const

Static Public Attributes
static const char *	XML_TAG = "WellboreMarker"

Additional Inherited Members
Protected Types inherited from common::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }

Protected Member Functions inherited from common::AbstractObject
	AbstractObject ()
	Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.

	AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)

	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)

void	initMandatoryMetadata ()

void	setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	cannotBePartial () const

void	changeToPartialObject ()

Static Protected Member Functions inherited from common::AbstractObject
static void	addActivityToResqmlObject (resqml2::Activity activity, AbstractObject resqmlObject)

Protected Attributes inherited from common::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1

gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1

common::EpcDocument *	epcDocument

std::vector< resqml2::Activity * >	activitySet

bool	updateXml

Detailed Description

This class is one of the only one to be a ResqmlDataObject which is not exported into a single file i.e. 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::WellboreMarker	(	class WellboreMarkerFrameRepresentation *	wellboreMarkerFrame,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

wellboreMarkerFrame	The wellbore marker frame which contains the wellbore marker to contruct.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.

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

Creates an instance of this class in a gsoap context.

Parameters

wellboreMarkerFrame	The wellbore marker frame which contains the wellbore marker to contruct.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.
geologicBoundaryKind	The type of the feature which the marker intersects.

resqml2_0_1::WellboreMarker::WellboreMarker	(	gsoap_resqml2_0_1::resqml2__WellboreMarker *	fromGsoap,
		class WellboreMarkerFrameRepresentation *	wellboreMarkerFrame
	)

inline

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

resqml2_0_1::WellboreMarker::~WellboreMarker ( )

inline

Destructor

Member Function Documentation

class BoundaryFeatureInterpretation* resqml2_0_1::WellboreMarker::getBoundaryFeatureInterpretation ( ) const

inline

Get the boundary feature interpretation linked to this well marker.

std::string WellboreMarker::getBoundaryFeatureInterpretationUuid ( ) const

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

resqml2__GeologicBoundaryKind WellboreMarker::getGeologicBoundaryKind ( )

Get the type of the intersected feature of the marker. Throw an exception if the marker has no GeologicBoundaryKind (see method hasAGeologicBoundaryKind).

virtual std::string resqml2_0_1::WellboreMarker::getXmlTag ( ) const

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

bool WellboreMarker::hasAGeologicBoundaryKind ( )

Indicates if the marker is associated to a particular GeologicBoundaryKind.

void WellboreMarker::setBoundaryFeatureInterpretation ( class BoundaryFeatureInterpretation * interp )

Set the boundary feature interpretation linked to this well marker.

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

C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/WellboreMarker.h
C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/WellboreMarker.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation