Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
witsml2_1::Trajectory Class Reference

It contains many trajectory stations to capture the information about individual survey points. More...

#include <Trajectory.h>

Inheritance diagram for witsml2_1::Trajectory:
WITSML2_NS::Trajectory WITSML2_NS::WellboreObject

Public Member Functions

 Trajectory (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 Trajectory (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title, bool isActive)
 Constructor.
 
 Trajectory (gsoap_eml2_3::witsml21__Trajectory *fromGsoap)
 
 ~Trajectory ()=default
 
common::DataObjectReference getWellboreDor () const final
 
void setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
 
void pushBackTrajectoryStation (gsoap_eml2_3::witsml21__TrajStationType kind, double mdValue, gsoap_eml2_3::eml23__LengthUom uom, const std::string &uid="") final
 
unsigned int getTrajectoryStationCount () const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from WITSML2_NS::Trajectory
 Trajectory (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual ~WellboreObject ()=default
 
WellboregetWellbore () const
 
virtual void loadTargetRelationships () override
 

Static Public Attributes

static constexpr char const * XML_NS = "witsml21"
 
- Static Public Attributes inherited from WITSML2_NS::Trajectory
static constexpr char const * XML_TAG = "Trajectory"
 

Detailed Description

It contains many trajectory stations to capture the information about individual survey points.

Constructor & Destructor Documentation

◆ Trajectory() [1/3]

witsml2_1::Trajectory::Trajectory ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Constructor for partial transfer

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ Trajectory() [2/3]

witsml2_1::Trajectory::Trajectory ( WITSML2_NS::Wellbore * witsmlWellbore,
const std::string & guid,
const std::string & title,
bool isActive )

Constructor.

Exceptions
std::invalid_argumentIf witsmlWellbore == nullptr.
Parameters
[in]witsmlWellboreIf non-null, the witsml wellbore.
guidUnique identifier.
titleThe title.
isActiveTrue if is active, false if not.

◆ Trajectory() [3/3]

witsml2_1::Trajectory::Trajectory ( gsoap_eml2_3::witsml21__Trajectory * fromGsoap)
inline

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

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

◆ ~Trajectory()

witsml2_1::Trajectory::~Trajectory ( )
virtualdefault

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

Reimplemented from WITSML2_NS::Trajectory.

Member Function Documentation

◆ getTrajectoryStationCount()

unsigned int witsml2_1::Trajectory::getTrajectoryStationCount ( ) const
finalvirtual

Get the count of trajectory stations in this trajectory

Returns
the count of trajectory stations in this trajectory.

Implements WITSML2_NS::Trajectory.

◆ getWellboreDor()

common::DataObjectReference witsml2_1::Trajectory::getWellboreDor ( ) const
finalvirtual

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

Implements WITSML2_NS::WellboreObject.

◆ getXmlNamespace()

std::string witsml2_1::Trajectory::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ pushBackTrajectoryStation()

void witsml2_1::Trajectory::pushBackTrajectoryStation ( gsoap_eml2_3::witsml21__TrajStationType kind,
double mdValue,
gsoap_eml2_3::eml23__LengthUom uom,
const std::string & uid = "" )
finalvirtual

Push back a minimal trajectory station into the trajectory.

Parameters
kindThe kind of trajectory station.
mdValueThe Measured Depth value of the trajectory station.
uomThe Measured Depth uom of the trajectory station.
uid(Optional) The uid of the trajectory station. Automatically set to its index if empty.

Implements WITSML2_NS::Trajectory.

◆ setWellbore()

void witsml2_1::Trajectory::setWellbore ( WITSML2_NS::Wellbore * witsmlWellbore)
finalvirtual

Set the wellbore linked with this data object.

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

Implements WITSML2_NS::WellboreObject.

Member Data Documentation

◆ XML_NS

constexpr char const* witsml2_1::Trajectory::XML_NS = "witsml21"
staticconstexpr

The standard XML namespace for serializing this data object.


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