Representation of a wellbore marker that is located along a wellbore trajectory, one for each MD value in the wellbore frame.
More...
#include <WellboreMarker.h>
Representation of a wellbore marker that is located along a wellbore trajectory, one for each MD value in the wellbore frame.
BUSINESS RULE: Ordering of the wellbore markers must match the ordering of the nodes in the wellbore marker frame representation.
◆ ~WellboreMarker()
| virtual resqml2::WellboreMarker::~WellboreMarker |
( |
| ) |
|
|
virtualdefault |
Destructor does nothing since the memory is managed by the gSOAP context.
◆ getBoundaryFeatureInterpretation()
Gets the boundary feature interpretation linked to this well marker.
- Returns
- The boundary feature interpretation linked to this well marker, or
nullptr if it fails.
◆ getBoundaryFeatureInterpretationDor()
Gets the DOR of the boundary feature interpretation linked to this well marker. Especially useful in partial transfer mode.
- Returns
- The boundary feature interpretation DOR, or empty DOR if it fails.
◆ getDipAngleUom()
| gsoap_eml2_3::eml23__PlaneAngleUom resqml2::WellboreMarker::getDipAngleUom |
( |
| ) |
const |
Get the Dip angle uom.
- Exceptions
-
| std::logic_error | If the marker has not got any dip value. |
- Returns
- the Dip angle uom.
◆ getDipAngleUomAsString()
| std::string resqml2::WellboreMarker::getDipAngleUomAsString |
( |
| ) |
const |
Get the Dip angle uom as a string.
- Exceptions
-
| std::logic_error | If the marker has not got any dip value. |
- Returns
- the Dip angle uom as a string.
◆ getDipAngleValue()
| double resqml2::WellboreMarker::getDipAngleValue |
( |
| ) |
const |
Get the Dip angle value.
- Exceptions
-
| std::logic_error | If the marker has not got any dip value. |
- Returns
- the Dip angle value.
◆ getDipDirectionUom()
| gsoap_eml2_3::eml23__PlaneAngleUom resqml2::WellboreMarker::getDipDirectionUom |
( |
| ) |
const |
Get the Dip direction uom.
- Exceptions
-
| std::logic_error | If the marker has not got any dip direction. |
- Returns
- the Dip direction uom.
◆ getDipDirectionUomAsString()
| std::string resqml2::WellboreMarker::getDipDirectionUomAsString |
( |
| ) |
const |
Get the Dip direction uom as a string.
- Exceptions
-
| std::logic_error | If the marker has not got any dip direction. |
- Returns
- the Dip direction uom as a string.
◆ getDipDirectionValue()
| double resqml2::WellboreMarker::getDipDirectionValue |
( |
| ) |
const |
Get the Dip direction value.
- Exceptions
-
| std::logic_error | If the marker has not got any dip direction. |
- Returns
- the Dip direction value.
◆ getGeologicBoundaryKind()
| virtual gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind resqml2::WellboreMarker::getGeologicBoundaryKind |
( |
| ) |
const |
|
pure virtual |
Gets the type of the intersected feature of the marker.
- Exceptions
-
- Returns
- The geologic boundary kind associated to this marker.
◆ getWellboreMarkerFrameRepresentation()
Gets the wellbore marker frame representation which contains this wellbore marker.
- Returns
- The wellbore marker frame representation which contains this wellbore marker frame, or
nullptr if it fails.
◆ getWitsmlWellboreMarker()
Gets the WITSML wellbore marker associated to this wellbore marker.
- Exceptions
-
| std::logic_error | If more than one WITSML wellbore marker is associated to this wellbore feature. |
- Returns
nullptr if no WITSML wellbore marker is associated to this wellbore marker, else the associated WITSML wellbore marker.
◆ getWitsmlWellboreMarkerDor()
Gets the DOR of the WITSML wellbore marker linked to this well marker. Especially useful in partial transfer mode.
- Returns
- The WITSML wellbore marker DOR, or empty DOR if it fails.
◆ hasAGeologicBoundaryKind()
| virtual bool resqml2::WellboreMarker::hasAGeologicBoundaryKind |
( |
| ) |
const |
|
pure virtual |
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.
◆ hasDipAngle()
| bool resqml2::WellboreMarker::hasDipAngle |
( |
| ) |
const |
Check wether this marker has got a dip angle or not. FYI, Dip Angle is store in the WITSML WellboreMarker companion if present.
- Returns
- true if this marker has got a dip angle.
◆ hasDipDirection()
| bool resqml2::WellboreMarker::hasDipDirection |
( |
| ) |
const |
Check wether this marker has got a dip direction or not. FYI, Dip direction is store in the WITSML WellboreMarker companion if present.
- Returns
- true if this marker has got a dip direction.
◆ setBoundaryFeatureInterpretation()
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. |
◆ setWitsmlWellboreMarker()
| virtual void resqml2::WellboreMarker::setWitsmlWellboreMarker |
( |
witsml2_1 ::WellboreMarker * | wellboreMarker | ) |
|
|
pure virtual |
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. |
◆ XML_TAG
| const char* resqml2::WellboreMarker::XML_TAG |
|
static |
The standard XML tag without XML namespace for serializing this data object.
The documentation for this class was generated from the following file:
