Fesapi 2.10.1.0
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
resqml2::SeismicWellboreFrameRepresentation Class Referenceabstract

A seismic wellbore frame representation. This class cannot be inherited. More...

#include <SeismicWellboreFrameRepresentation.h>

Inheritance diagram for resqml2::SeismicWellboreFrameRepresentation:
resqml2::WellboreFrameRepresentation resqml2::AbstractRepresentation common::AbstractObject resqml2_2::SeismicWellboreFrameRepresentation

Public Member Functions

void setTimeValues (double const *timeValues, uint64_t timeValueCount, eml2::AbstractHdfProxy *proxy=nullptr)
 
void setTimeValues (double firstTimeValue, double incrementTimeValue, unsigned int timeValueCount)
 
bool areTimeValuesRegularlySpaced () const
 
double getTimeConstantIncrementValue () const
 
double getTimeFirstValue () const
 
unsigned int getTimeValuesCount () const
 
common::AbstractObject::numericalDatatypeEnum getTimeHdfDatatype () const
 
void getTimeAsDoubleValues (double *values) const
 
void getTimeAsFloatValues (float *values) const
 
virtual common::DataObjectReference getTimeCrsDor () const =0
 
eml2::AbstractLocal3dCrs * getTimeCrs () const
 
double getSeismicReferenceDatum () const
 
double getWeatheringVelocity () const
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::WellboreFrameRepresentation
 ~WellboreFrameRepresentation ()=default
 
void setMdValues (double const *mdValues, uint64_t mdValueCount, eml2::AbstractHdfProxy *proxy=nullptr)
 
void setMdValues (double firstMdValue, double incrementMdValue, unsigned int mdValueCount)
 
bool areMdValuesRegularlySpaced () const
 
double getMdConstantIncrementValue () const
 
double getMdFirstValue () const
 
unsigned int getMdValuesCount () const
 
uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const override
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const override
 
common::AbstractObject::numericalDatatypeEnum getMdHdfDatatype () const
 
void getMdAsDoubleValues (double *values) const
 
void getMdAsFloatValues (float *values) const
 
common::DataObjectReference getWellboreTrajectoryDor () const
 
class WellboreTrajectoryRepresentation * getWellboreTrajectory () const
 
common::DataObjectReference getLocalCrsDor (uint64_t patchIndex) const override
 
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).
 
uint64_t getPatchCount () const final
 
- Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()=default
 
eml2::AbstractLocal3dCrs * getLocalCrs (uint64_t patchIndex) const
 
void setTimeIndex (uint64_t timeIndex, eml2::TimeSeries *timeSeries)
 
uint64_t getTimeIndex () const
 Gets the time index of this representation in the associated TimeSeries. Be sure to first check that a TimeSeries is associated this representation by calling getTimeSeriesDor or getTimeSeries;.
 
eml2::TimeSeries * getTimeSeries () const
 
common::DataObjectReference getTimeSeriesDor () const
 Gets the data object reference of the TimeSeries containing the time of this representation at a particular index. For now, this method only look for a TimeSeries at the first patch containing a point geometry.
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretation * getInterpretation () 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.
 
void getXyzPointsOfAllPatches (double *xyzPoints) const
 Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS.
 
bool isInSingleLocalCrs () const
 
bool isInSingleGlobalCrs () const
 
void getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
 
AbstractRepresentation * getSeismicSupportOfPatch (const unsigned int &patchIndex) const
 
std::set< AbstractRepresentation * > getAllSeismicSupport () const
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)
 
void addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double *inlines, double *crosslines, uint64_t 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)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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 getXmlNamespace () const =0
 
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)
 
uint64_t getAliasCount () const
 
std::string getAliasAuthorityAtIndex (uint64_t index) const
 
std::string getAliasTitleAtIndex (uint64_t index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
uint64_t getActivityCount () const
 
eml2::Activity * getActivity (uint64_t 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
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 

Static Public Attributes

static constexpr char const * XML_TAG = "SeismicWellboreFrameRepresentation"
 
- Static Public Attributes inherited from resqml2::AbstractRepresentation
static constexpr char const * XML_TAG = "AbstractRepresentation"
 

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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 seismic wellbore frame representation. This class cannot be inherited.

Member Function Documentation

◆ areTimeValuesRegularlySpaced()

bool resqml2::SeismicWellboreFrameRepresentation::areTimeValuesRegularlySpaced ( ) const

Indicates either the times are regularly spaced or not (useful for optimization) Does not verify if the writer has used a generic array to store regular times.

◆ getSeismicReferenceDatum()

double resqml2::SeismicWellboreFrameRepresentation::getSeismicReferenceDatum ( ) const

Returns the seismic reference datum

◆ getTimeAsDoubleValues()

void resqml2::SeismicWellboreFrameRepresentation::getTimeAsDoubleValues ( double * values) const

Get all the time values of the instance which are supposed to be double ones.

◆ getTimeAsFloatValues()

void resqml2::SeismicWellboreFrameRepresentation::getTimeAsFloatValues ( float * values) const

Get all the time values of the instance which are supposed to be float ones.

◆ getTimeConstantIncrementValue()

double resqml2::SeismicWellboreFrameRepresentation::getTimeConstantIncrementValue ( ) const

Indicates the increment value between two times only if the times are regularly spaced. Please use areTimeValuesRegularlySpaced before using this method.

◆ getTimeCrs()

eml2::AbstractLocal3dCrs * resqml2::SeismicWellboreFrameRepresentation::getTimeCrs ( ) const

Gets the Local Time CRS of this seismic wellbore frame.

Returns
Local Time CRS of this seismic wellbore frame.

◆ getTimeCrsDor()

virtual common::DataObjectReference resqml2::SeismicWellboreFrameRepresentation::getTimeCrsDor ( ) const
pure virtual

Gets the data object reference of the Local Time CRS of this seismic wellbore frame.

Returns
The data object reference of the Local Time CRS of this seismic wellbore frame.

Implemented in resqml2_2::SeismicWellboreFrameRepresentation.

◆ getTimeFirstValue()

double resqml2::SeismicWellboreFrameRepresentation::getTimeFirstValue ( ) const

Returns the first time value of this SeismicWellboreFrameRepresentation

◆ getTimeHdfDatatype()

common::AbstractObject::numericalDatatypeEnum resqml2::SeismicWellboreFrameRepresentation::getTimeHdfDatatype ( ) const

Get the time values datatype in the HDF dataset

◆ getTimeValuesCount()

unsigned int resqml2::SeismicWellboreFrameRepresentation::getTimeValuesCount ( ) const

Get the number of time values in this seismic wellbore frame.

◆ getWeatheringVelocity()

double resqml2::SeismicWellboreFrameRepresentation::getWeatheringVelocity ( ) const

Returns the weathering velocity

◆ getXmlTag()

virtual std::string resqml2::SeismicWellboreFrameRepresentation::getXmlTag ( ) const
inlinefinalvirtual

Get the standard XML tag without XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setTimeValues() [1/2]

void resqml2::SeismicWellboreFrameRepresentation::setTimeValues ( double const * timeValues,
uint64_t timeValueCount,
eml2::AbstractHdfProxy * proxy = nullptr )

Set the time values of this SeismicWellboreFrameRepresentation frame to an array 1d of explicit values.

Parameters
timeValuesAll the time values to set from top of the well trajectory to bottom.
timeValueCountThe time values count. It must be the same that the md values count.
proxyThe HDF proxy where to write the time values. It must be already opened for writing and won't be closed in this method.

◆ setTimeValues() [2/2]

void resqml2::SeismicWellboreFrameRepresentation::setTimeValues ( double firstTimeValue,
double incrementTimeValue,
unsigned int timeValueCount )

Set the time values of this WellboreFrameRepresentation frame as a regular discretization along the wellbore trajectory.

Parameters
firstTimeValueThe first time value.
incrementTimeValueThe increment value between two time values. It must be the same that the md values count.
timeValueCountThe count of time values in this WellboreFrameRepresentation.

Member Data Documentation

◆ XML_TAG

char const* resqml2::SeismicWellboreFrameRepresentation::XML_TAG = "SeismicWellboreFrameRepresentation"
staticconstexpr

The standard XML tag without XML namespace for serializing this data object.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0