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:

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

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. More...

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

AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const

std::set< AbstractRepresentation * >	getAllSeismicSupport () const

virtual unsigned int	getPatchCount () const =0

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

virtual void	loadTargetRelationships () override

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_1::eml21__AbstractObject *	getEml21GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

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::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)

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::Activity *	getActivity (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

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

virtual void	loadTargetRelationships ()=0

Additional Inherited Members
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)

Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char *	XML_TAG

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_error If 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_range	If `index >=` getBoundariesCount().
std::logic_error	If the RESQML version is unknown.

Parameters

index Zero-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_error If 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_argument	If `outerRing` `== nullptr`.
std::logic_error	If the RESQML version is unknown.

Parameters

[in] outerRing A 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_error If the RESQML version is unknown.

Parameters

surfaceRole The 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:

C:/Users/philippe/dev/fesapiEnv/fesapi-2.3.0.0/src/resqml2/AbstractSurfaceRepresentation.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractSurfaceRepresentation()

Member Function Documentation

◆ getBoundariesCount()

◆ getOuterRingDor()

◆ getSurfaceRole()

◆ pushBackOuterRing()

◆ setSurfaceRole()