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 | Static Public Attributes | List of all members
resqml2_2::DeviationSurveyRepresentation Class Referencefinal

#include <DeviationSurveyRepresentation.h>

Inheritance diagram for resqml2_2::DeviationSurveyRepresentation:
resqml2::DeviationSurveyRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 DeviationSurveyRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 DeviationSurveyRepresentation (class resqml2::WellboreInterpretation *interp, const std::string &guid, const std::string &title, bool isFinal, resqml2::MdDatum *mdInfo)
 Creates an instance of this class in a gsoap context. More...
 
 DeviationSurveyRepresentation (gsoap_eml2_3::_resqml22__DeviationSurveyRepresentation *fromGsoap)
 
 ~DeviationSurveyRepresentation ()=default
 
void setGeometry (double const *firstStationLocation, uint64_t stationCount, gsoap_resqml2_0_1::eml20__LengthUom mdUom, double const *mds, gsoap_resqml2_0_1::eml20__PlaneAngleUom angleUom, double const *azimuths, double const *inclinations, eml2::AbstractHdfProxy *proxy) final
 
void setMdDatum (resqml2::MdDatum *mdDatum) final
 
common::DataObjectReference getMdDatumDor () const final
 
bool isFinal () const final
 
uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const final
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS. More...
 
gsoap_resqml2_0_1::eml20__LengthUom getMdUom () const final
 
gsoap_resqml2_0_1::eml20__PlaneAngleUom getAngleUom () const final
 
void getMdValues (double *values) const final
 
void getInclinations (double *values) const final
 
void getAzimuths (double *values) const final
 
common::DataObjectReference getHdfProxyDor () const final
 Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry). More...
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::DeviationSurveyRepresentation
class MdDatumgetMdDatum () const
 
std::vector< class resqml2::WellboreFrameRepresentation * > getWellboreFrameRepresentationSet () const
 
unsigned int getWellboreFrameRepresentationCount () const
 
class resqml2::WellboreFrameRepresentationgetWellboreFrameRepresentation (unsigned int index) const
 
std::vector< class WellboreTrajectoryRepresentation * > getWellboreTrajectoryRepresentationSet () const
 
unsigned int getWellboreTrajectoryRepresentationCount () const
 
class WellboreTrajectoryRepresentationgetWellboreTrajectoryRepresentation (unsigned int index) const
 
unsigned int getPatchCount () const final
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()=default
 
class AbstractLocal3dCrsgetLocalCrs (unsigned int patchIndex) const
 
virtual common::DataObjectReference getLocalCrsDor (unsigned int patchIndex) const
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () const
 
common::DataObjectReference getInterpretationDor () const
 
uint64_t getXyzPointCountOfAllPatches () const
 
void getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS. More...
 
void getXyzPointsOfAllPatches (double *xyzPoints) const
 Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS. More...
 
bool isInSingleLocalCrs () const
 
bool isInSingleGlobalCrs () const
 
void getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
 
AbstractRepresentationgetSeismicSupportOfPatch (const unsigned int &patchIndex) const
 
std::set< AbstractRepresentation * > getAllSeismicSupport () const
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)
 
void addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double *inlines, double *crosslines, unsigned int pointCount, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
 
void addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)
 
void addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double *lineAbscissa, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
 
void getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
void getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
void getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
- 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::DataObjectRepositorygetRepository () 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::ActivitygetActivity (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::DeviationSurveyRepresentation
static const char * XML_TAG
 
- Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char * XML_TAG
 

Additional Inherited Members

- Public Types inherited from resqml2::AbstractRepresentation
enum  indexableElement {
  NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 ,
  PILLAR = 4
}
 
- 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

A deviation survey representation.

Constructor & Destructor Documentation

◆ DeviationSurveyRepresentation() [1/3]

resqml2_2::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

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

◆ DeviationSurveyRepresentation() [2/3]

resqml2_2::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( class resqml2::WellboreInterpretation interp,
const std::string &  guid,
const std::string &  title,
bool  isFinal,
resqml2::MdDatum mdInfo 
)

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf interp == nullptr or mdInfo == nullptr.
Parameters
[in]interpThe WellboreFeature interpretation the instance represents.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.
isFinalUsed to indicate that this is a final version of the deviation survey, as distinct from the interim interpretations.
[in]mdInfoThe MD information of the survey, mainly the well reference point.

◆ DeviationSurveyRepresentation() [3/3]

resqml2_2::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( gsoap_eml2_3::_resqml22__DeviationSurveyRepresentation *  fromGsoap)
inline

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

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

◆ ~DeviationSurveyRepresentation()

resqml2_2::DeviationSurveyRepresentation::~DeviationSurveyRepresentation ( )
virtualdefault

Destructor

Reimplemented from resqml2::DeviationSurveyRepresentation.

Member Function Documentation

◆ getAngleUom()

gsoap_resqml2_0_1::eml20__PlaneAngleUom resqml2_2::DeviationSurveyRepresentation::getAngleUom ( ) const
finalvirtual

Gets the unit of measure of the azimuth and inclination angle values of this deviation survey.

Returns
The unit of measure of the azimuth and inclination angle values.

Implements resqml2::DeviationSurveyRepresentation.

◆ getAzimuths()

void resqml2_2::DeviationSurveyRepresentation::getAzimuths ( double *  values) const
finalvirtual

Gets the azimuth double values associated to each trajectory station of this deviation survey representation. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. The uom is given by getAngleUom().

Exceptions
logic_errorIf the data structure used to store the azimuth values cannot be read for now by fesapi.
Parameters
[out]valuesAn array to receive the azimuth double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

Implements resqml2::DeviationSurveyRepresentation.

◆ getHdfProxyDor()

common::DataObjectReference resqml2_2::DeviationSurveyRepresentation::getHdfProxyDor ( ) const
finalvirtual

Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

Exceptions
std::logic_errorIf this representation is partial.
Returns
The data object reference of the HDF proxy used for storing the geometry, or empty data object reference if it fails.

Implements resqml2::AbstractRepresentation.

◆ getInclinations()

void resqml2_2::DeviationSurveyRepresentation::getInclinations ( double *  values) const
finalvirtual

Gets the inclination double values associated to each trajectory station of this deviation survey representation. The uom is given by getAngleUom().

Exceptions
logic_errorIf the data structure used to store the inclination values cannot be read for now by fesapi.
Parameters
[out]valuesAn array to receive the inclination double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

Implements resqml2::DeviationSurveyRepresentation.

◆ getMdDatumDor()

common::DataObjectReference resqml2_2::DeviationSurveyRepresentation::getMdDatumDor ( ) const
finalvirtual

Gets the DOR of the MD datum of this deviation survey representation.

Returns
The DOR of the MD datum of this deviation survey representation.

Implements resqml2::DeviationSurveyRepresentation.

◆ getMdUom()

gsoap_resqml2_0_1::eml20__LengthUom resqml2_2::DeviationSurveyRepresentation::getMdUom ( ) const
finalvirtual

Gets the unit of measure of the MDs along this deviation survey.

Returns
The unit of measure of the MDs.

Implements resqml2::DeviationSurveyRepresentation.

◆ getMdValues()

void resqml2_2::DeviationSurveyRepresentation::getMdValues ( double *  values) const
finalvirtual

Gets the MD double values associated to each trajectory station of this deviation survey representation. The uom is given by getMdUom().

Exceptions
logic_errorIf the data structure used to store the MD values cannot be read for now by fesapi.
Parameters
[out]valuesAn array to receive the MD double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

Implements resqml2::DeviationSurveyRepresentation.

◆ getXmlNamespace()

std::string resqml2_2::DeviationSurveyRepresentation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXyzPointCountOfPatch()

uint64_t resqml2_2::DeviationSurveyRepresentation::getXyzPointCountOfPatch ( unsigned int  patchIndex) const
finalvirtual

Get the xyz point count in a given patch of this representation.

Exceptions
std::out_of_rangeIf patchIndex is out of range.
std::logic_errorIf this representation is partial.
Parameters
patchIndexZero-based index of the patch from which we look for the xyz points.
Returns
The xyz point count of the patch at position patchIndex.

Implements resqml2::AbstractRepresentation.

◆ getXyzPointsOfPatch()

void resqml2_2::DeviationSurveyRepresentation::getXyzPointsOfPatch ( unsigned int  patchIndex,
double *  xyzPoints 
) const
finalvirtual

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions
std::out_of_rangeIf patchIndex is out of range.
std::logic_errorIf this representation is partial.
Parameters
patchIndexZero-based index of the patch from which we look for the xyz points.
[out]xyzPointsA linearized 2d array where the first (quickest) dimension is the coordinate dimension (x, y or z) and second dimension is vertex dimension. It must be preallocated with a size of 3 * getXyzPointCountOfPatch(patchIndex).

Implements resqml2::AbstractRepresentation.

◆ isFinal()

bool resqml2_2::DeviationSurveyRepresentation::isFinal ( ) const
finalvirtual

Checks whether this is a final version of the deviation survey, as distinct from the interim interpretations.

Returns
True if it is a final version, false if not.

Implements resqml2::DeviationSurveyRepresentation.

◆ setGeometry()

void resqml2_2::DeviationSurveyRepresentation::setGeometry ( double const *  firstStationLocation,
uint64_t  stationCount,
gsoap_resqml2_0_1::eml20__LengthUom  mdUom,
double const *  mds,
gsoap_resqml2_0_1::eml20__PlaneAngleUom  angleUom,
double const *  azimuths,
double const *  inclinations,
eml2::AbstractHdfProxy proxy 
)
finalvirtual

Sets the geometry of this deviation survey representation.

Exceptions
std::invalid_argumentIf firstStationLocation, mds, azimuths or inclinations is @ nullptr.
std::invalid_argumentIf proxy == nullptr and no default HDF proxy is defined in the repository.
Parameters
firstStationLocationAn array of size 3 containing the coordinates x, y and z of the first station of this deviation survey in the local CRS.
stationCountThe number of stations (including the first station).
mdUomThe units of measure of the measured depths along this deviation survey.
mdsAn array containing the MD values of the stations. The array length equals stationCount.
angleUomThe unit of measure of both azimuth and inclination values.
azimuthsAn array of azimuth angles, one for each survey station. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. Array length equals stationCount.
inclinationsInclination (or dip) angle for each station. Array length equals stationCount.
[in,out]proxyThe HDF proxy where the numerical values will be stored. It must be already opened for writing and won't be closed. If nullptr, then the default HDF proxy of the repository will be used.

Implements resqml2::DeviationSurveyRepresentation.

◆ setMdDatum()

void resqml2_2::DeviationSurveyRepresentation::setMdDatum ( resqml2::MdDatum mdDatum)
finalvirtual

Sets the MD datum of this deviation survey representation.

Exceptions
std::invalid_argumentIf mdDatum == nullptr.
Parameters
[in]mdDatumThe MD datum to set.

Implements resqml2::DeviationSurveyRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::DeviationSurveyRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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