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 | List of all members
resqml2::AbstractSurfaceRepresentation Class Reference

An abstract surface representation. It is the parent class of structural surface representations, which can be bounded by an outer ring and has inner rings. These surfaces may consist of one or more patches. More...

#include <AbstractSurfaceRepresentation.h>

Inheritance diagram for resqml2::AbstractSurfaceRepresentation:
resqml2::AbstractRepresentation resqml2::Grid2dRepresentation resqml2::PlaneSetRepresentation resqml2::TriangulatedSetRepresentation

Public Member Functions

virtual ~AbstractSurfaceRepresentation ()=default
 
unsigned int getBoundariesCount () const
 
common::DataObjectReference getOuterRingDor (unsigned int index) const
 
void pushBackOuterRing (PolylineRepresentation *outerRing)
 
void setSurfaceRole (gsoap_resqml2_0_1::resqml20__SurfaceRole surfaceRole)
 
gsoap_resqml2_0_1::resqml20__SurfaceRole getSurfaceRole () const
 
- Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()=default
 
class AbstractLocal3dCrs * getLocalCrs (unsigned int patchIndex) const
 
virtual common::DataObjectReference getLocalCrsDor (unsigned int patchIndex) const
 
virtual common::DataObjectReference getHdfProxyDor () const =0
 Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).
 
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
 
virtual uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const =0
 
uint64_t getXyzPointCountOfAllPatches () const
 
virtual void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const =0
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.
 
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
 
virtual uint64_t getPatchCount () const =0
 
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
 

Additional Inherited Members

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

Detailed Description

An abstract surface representation. It is the parent class of structural surface representations, which can be bounded by an outer ring and has inner rings. These surfaces may consist of one or more patches.

Constructor & Destructor Documentation

◆ ~AbstractSurfaceRepresentation()

virtual resqml2::AbstractSurfaceRepresentation::~AbstractSurfaceRepresentation ( )
virtualdefault

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

Member Function Documentation

◆ getBoundariesCount()

unsigned int resqml2::AbstractSurfaceRepresentation::getBoundariesCount ( ) const

Gets the count of boundaries.

Exceptions
std::logic_errorIf the RESQML version is unknown.
Returns
The boundaries count.

◆ getOuterRingDor()

common::DataObjectReference resqml2::AbstractSurfaceRepresentation::getOuterRingDor ( unsigned int index) const

Gets the DOR of an outer ring at a particular index.

Exceptions
std::out_of_rangeIf index >= getBoundariesCount().
std::logic_errorIf the RESQML version is unknown.
Parameters
indexZero-based index of the outer ring we look for.
Returns
The DOR of the outer ring at position index.

◆ getSurfaceRole()

gsoap_resqml2_0_1::resqml20__SurfaceRole resqml2::AbstractSurfaceRepresentation::getSurfaceRole ( ) const

Gets the surface role of this representation.

Exceptions
std::logic_errorIf the RESQML version is unknown.
Returns
The surface role of this representation. It can be "map" (representation support for properties) or "pick" (representation support for 3d points picked in 2d or 3d).

◆ pushBackOuterRing()

void resqml2::AbstractSurfaceRepresentation::pushBackOuterRing ( PolylineRepresentation * outerRing)

Pushes back an outer ring at the first available boundary index of this surface representation. The index of the patch referenced by this ring will be the same index than this ring boundary.

Exceptions
std::invalid_argumentIf outerRing == nullptr.
std::logic_errorIf the RESQML version is unknown.
Parameters
[in]outerRingA polyline representation of the outer ring to push back.

◆ setSurfaceRole()

void resqml2::AbstractSurfaceRepresentation::setSurfaceRole ( gsoap_resqml2_0_1::resqml20__SurfaceRole surfaceRole)

Sets the surface role of this representation.

Exceptions
std::logic_errorIf the RESQML version is unknown.
Parameters
surfaceRoleThe surface role to set. It can be "map" (representation support for properties) or "pick" (representation support for 3d points picked in 2d or 3d).
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0