Defines a plane representation, which can be made up of multiple patches. Commonly represented features are fluid contacts or frontiers. Common geometries of this representation are titled or horizontal planes. More...

#include <PlaneSetRepresentation.h>

Inheritance diagram for resqml2::PlaneSetRepresentation:

Public Member Functions
virtual	~PlaneSetRepresentation ()=default

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

virtual void	pushBackHorizontalPlaneGeometryPatch (double zCoordinate, eml2::AbstractLocal3dCrs *localCrs=nullptr)=0

virtual void	pushBackTiltedPlaneGeometryPatch (double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3, eml2::AbstractLocal3dCrs *localCrs=nullptr)=0

virtual std::string	getXmlTag () const final

Public Member Functions inherited from resqml2::AbstractSurfaceRepresentation
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

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

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 = "PlaneSetRepresentation"

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

Defines a plane representation, which can be made up of multiple patches. Commonly represented features are fluid contacts or frontiers. Common geometries of this representation are titled or horizontal planes.

BUSINESS RULE: If the plane representation is made up of multiple patches, then you must specify the outer rings for each plane patch.

Constructor & Destructor Documentation

◆ ~PlaneSetRepresentation()

virtual resqml2::PlaneSetRepresentation::~PlaneSetRepresentation ( )

virtualdefault

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

Reimplemented in resqml2_0_1::PlaneSetRepresentation, and resqml2_2::PlaneSetRepresentation.

Member Function Documentation

◆ getHdfProxyDor()

common::DataObjectReference resqml2::PlaneSetRepresentation::getHdfProxyDor ( ) const

inlinevirtual

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

Returns: Empty DOR since plane set representation values do not rely a HDF proxy (it is XML only).

Implements resqml2::AbstractRepresentation.

◆ getXmlTag()

virtual std::string resqml2::PlaneSetRepresentation::getXmlTag ( ) const

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ pushBackHorizontalPlaneGeometryPatch()

virtual void resqml2::PlaneSetRepresentation::pushBackHorizontalPlaneGeometryPatch	(	double	zCoordinate,
		eml2::AbstractLocal3dCrs *	localCrs = nullptr )

pure virtual

Pushes back a new patch which is an horizontal plane.

Exceptions

std::invalid_argument If localCrs == nullptr and no default CRS is defined in the repository.

Parameters

	zCoordinate	The z coordinate of the horizontal plane.
[in]	localCrs	(Optional) If non-null, the local CRS. If `nullptr` (default), the repository default local CRS will be used.

Implemented in resqml2_0_1::PlaneSetRepresentation, and resqml2_2::PlaneSetRepresentation.

◆ pushBackTiltedPlaneGeometryPatch()

virtual void resqml2::PlaneSetRepresentation::pushBackTiltedPlaneGeometryPatch	(	double	x1,
		double	y1,
		double	z1,
		double	x2,
		double	y2,
		double	z2,
		double	x3,
		double	y3,
		double	z3,
		eml2::AbstractLocal3dCrs *	localCrs = nullptr )

pure virtual

Pushs back a new patch which is not a horizontal plane. Its geometry is given by means of 3 xyz points.

Exceptions

std::invalid_argument If localCrs == nullptr and no default CRS is defined in the repository.

Parameters

	x1	The x value of the first point.
	y1	The y value of the first point.
	z1	The z value of the first point.
	x2	The x value of the second point.
	y2	The y value of the second point.
	z2	The z value of the second point.
	x3	The x value of the third point.
	y3	The y value of the third point.
	z3	The z value of the third point.
[in]	localCrs	(Optional) If non-null, the local CRS. If `nullptr` (default), the repository default local CRS will be used.

Implemented in resqml2_0_1::PlaneSetRepresentation, and resqml2_2::PlaneSetRepresentation.

Member Data Documentation

◆ XML_TAG

char const* resqml2::PlaneSetRepresentation::XML_TAG = "PlaneSetRepresentation"

staticconstexpr

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

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2/PlaneSetRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members