Fesapi 2.14.0.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 | 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 common::AbstractObject resqml2::Grid2dRepresentation resqml2::PlaneSetRepresentation resqml2::TriangulatedSetRepresentation resqml2_0_1::Grid2dRepresentation resqml2_2::Grid2dRepresentation resqml2_0_1::PlaneSetRepresentation resqml2_2::PlaneSetRepresentation resqml2_0_1::TriangulatedSetRepresentation resqml2_2::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
eml2::AbstractLocal3dCrs * getLocalCrs (uint64_t patchIndex) const
virtual common::DataObjectReference getLocalCrsDor (uint64_t 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 (uint64_t patchIndex) const =0
uint64_t getXyzPointCountOfAllPatches () const
virtual void getXyzPointsOfPatch (uint64_t 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 (uint64_t 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 (uint64_t patchIndex) const
std::set< AbstractRepresentation * > getAllSeismicSupport () const
virtual uint64_t getPatchCount () const =0
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)
void addSeismic3dCoordinatesToPatch (uint64_t patchIndex, double *inlines, double *crosslines, uint64_t pointCount, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
void addSeismic3dCoordinatesToPatch (uint64_t patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)
void addSeismic2dCoordinatesToPatch (uint64_t patchIndex, double *lineAbscissa, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
void getSeismicLineAbscissaOfPointsOfPatch (uint64_t patchIndex, double *values) const
void getInlinesOfPointsOfPatch (uint64_t patchIndex, double *values) const
void getCrosslinesOfPointsOfPatch (uint64_t 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 getXmlTag () 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
uint64_t getExtraMetadataCount () const
std::string getExtraMetadataKeyAtIndex (uint64_t index) const
std::string getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string buildEtp12Uri () const
void setUriSource (const std::string &uriSource)
const std::string & getUriSource () const
std::string getEpcSourceFolder () const
void changeToPartialObject ()
template<>
int8_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const
template<>
uint8_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const
template<>
int16_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const
template<>
uint16_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const
template<>
int32_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const
template<>
uint32_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const
template<>
int64_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const
template<>
uint64_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const
template<>
int8_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const
template<>
uint8_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const
template<>
int16_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const
template<>
uint16_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const
template<>
int32_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const
template<>
uint32_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const
template<>
int64_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const
template<>
uint64_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const

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)
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.15.0