A strict boundary representation (BREP), which represents the volume region by assembling together shells. More...

#include <SealedVolumeFrameworkRepresentation.h>

Inheritance diagram for resqml2::SealedVolumeFrameworkRepresentation:

Public Member Functions
virtual	~SealedVolumeFrameworkRepresentation ()=default

void	setSealedSurfaceFramework (SealedSurfaceFrameworkRepresentation *ssf)

void	setInterpretationOfVolumeRegion (uint64_t regionIndex, StratigraphicUnitInterpretation *stratiUnitInterp)

virtual void	pushBackVolumeRegion (StratigraphicUnitInterpretation stratiUnitInterp, unsigned int externalShellFaceCount, unsigned int const faceRepresentationIndices, unsigned int const faceRepPatchIndices, bool const faceSide)=0

virtual void	pushBackInternalShell (uint64_t regionIndex, unsigned int internalShellFaceCount, unsigned int const faceRepresentationIndices, unsigned int const faceRepPatchIndices, bool const *faceSide)=0

SealedSurfaceFrameworkRepresentation *	getSealedStructuralFramework () const

class StratigraphicUnitInterpretation *	getStratiUnitInterp (uint64_t regionIndex) const

virtual uint64_t	getRegionCount () const =0

virtual uint64_t	getInternalShellCount (uint64_t regionIndex) const =0

virtual uint64_t	getFaceCountOfExternalShell (uint64_t regionIndex) const =0

virtual uint64_t	getFaceCountOfInternalShell (uint64_t regionIndex, unsigned int internalShellIndex) const =0

virtual resqml2::AbstractRepresentation *	getRepOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0

virtual resqml2::AbstractRepresentation *	getRepOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0

virtual uint64_t	getRepPatchIndexOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0

virtual uint64_t	getRepPatchIndexOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0

virtual bool	getSideFlagOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0

virtual bool	getSideFlagOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0

virtual std::string	getXmlTag () const final

Public Member Functions inherited from resqml2::RepresentationSetRepresentation
virtual	~RepresentationSetRepresentation ()=default

common::DataObjectReference	getHdfProxyDor () const final

uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const override

void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const override

uint64_t	getPatchCount () const override

bool	isHomogeneous () const

uint64_t	getRepresentationCount () const

resqml2::AbstractRepresentation *	getRepresentation (uint64_t index) const

common::DataObjectReference	getRepresentationDor (uint64_t index) const

void	pushBack (resqml2 ::AbstractRepresentation *rep)

Static Public Attributes
static const char *	XML_TAG

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

Detailed Description

A strict boundary representation (BREP), which represents the volume region by assembling together shells.

BUSINESS RULE: The sealed structural framework must be part of the same earth model as this sealed volume framework.

Constructor & Destructor Documentation

◆ ~SealedVolumeFrameworkRepresentation()

virtual resqml2::SealedVolumeFrameworkRepresentation::~SealedVolumeFrameworkRepresentation ( )

virtualdefault

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

Member Function Documentation

◆ getFaceCountOfExternalShell()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getFaceCountOfExternalShell ( uint64_t regionIndex ) const

pure virtual

Gets the count of faces in a particular region external shell.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::range_error	If the count of faces is strictly greater than unsigned int max.

Parameters

regionIndex Zero-based index of the framework region.

Returns: The count of faces in the external shell of the region at position regionIndex.

◆ getFaceCountOfInternalShell()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getFaceCountOfInternalShell	(	uint64_t	regionIndex,
		unsigned int	internalShellIndex ) const

pure virtual

Gets the count of faces in a particular region internal shell.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `internalShellIndex >= getInternalShellCount(regionIndex)`.
std::range_error	If the count of faces is strictly greater than unsigned int max.

Parameters

regionIndex	Zero-based index of the region.
internalShellIndex	Zero-based index of the internal shell.

Returns: The count of faces of the region regionIndex internal shell internalShellIndex.

◆ getInternalShellCount()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getInternalShellCount ( uint64_t regionIndex ) const

pure virtual

Gets the count of internal shells in a particular region.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::range_error	If the count of internal shells is strictly greater than unsigned int max.

Parameters

regionIndex Zero-based index of the framework region.

Returns: The count of internal shells in the region at position regionIndex.

◆ getRegionCount()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getRegionCount ( ) const

pure virtual

Gets the count of regions in this framework.

Exceptions

std::range_error If the count of regions is strictly greater than unsigned int.

Returns: The count of regions in this framework.

◆ getRepOfExternalShellFace()

virtual resqml2::AbstractRepresentation * resqml2::SealedVolumeFrameworkRepresentation::getRepOfExternalShellFace	(	uint64_t	regionIndex,
		unsigned int	faceIndex ) const

pure virtual

Gets the representation (for instance the triangulated surface) which contains a particular face of the external shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `faceIndex >= getFaceCountOfExternalShell(regionIndex)`.

Parameters

regionIndex	Zero-based index of the region.
faceIndex	Zero-base index of the external shell face.

Returns: The representation which contains the face faceIndex of the external shell of the region regionIndex of this framework.

◆ getRepOfInternalShellFace()

virtual resqml2::AbstractRepresentation * resqml2::SealedVolumeFrameworkRepresentation::getRepOfInternalShellFace	(	uint64_t	regionIndex,
		unsigned int	internalShellIndex,
		unsigned int	faceIndex ) const

pure virtual

Gets the representation (for instance the triangulated surface) which contains a particular face of a particular internal shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `internalShellIndex >= getInternalShellCount(regionIndex)`.
std::out_of_range	If `faceIndex >= getFaceCountOfInternalShell(regionIndex, internalShellIndex)`.

Parameters

regionIndex	Zero-based index of the framework region.
internalShellIndex	Zero-based index of the internal shell.
faceIndex	Zero-based index of the face of the framework region internal shell.

Returns: The representation which contains the face faceIndex of the internal shell internalShellIndex of the region regionIndex of this framework.

◆ getRepPatchIndexOfExternalShellFace()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getRepPatchIndexOfExternalShellFace	(	uint64_t	regionIndex,
		unsigned int	faceIndex ) const

pure virtual

Get the representation patch index corresponding to a particular face of the external shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `faceIndex >= getFaceCountOfExternalShell(regionIndex)`.

Parameters

regionIndex	Zero-based index of the framework region.
faceIndex	Zero-based index of the external shell face.

Returns: The representation patch index (on representation getRepOfExternalShellFace(regionIndex, faceIndex)) which is the face faceIndex of the external shell of the region regionIndex of this framework.

◆ getRepPatchIndexOfInternalShellFace()

virtual uint64_t resqml2::SealedVolumeFrameworkRepresentation::getRepPatchIndexOfInternalShellFace	(	uint64_t	regionIndex,
		unsigned int	internalShellIndex,
		unsigned int	faceIndex ) const

pure virtual

Get the representation patch index corresponding to a particular face of particular internal shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `internalShellIndex >= getInternalShellCount(regionIndex)`.
std::out_of_range	If `faceIndex >= getFaceCountOfInternalShell(regionIndex, internalShellIndex)`.

Parameters

regionIndex	Zero-based index of the framework region.
internalShellIndex	Zero-based index of the internal shell.
faceIndex	Zero-based index of the face.

Returns: The representation patch index (on representation getRepOfInternalShellFace(regionIndex, internalShellIndex, faceIndex)) which is the face faceIndex of the internal shell internalShellIndex of the region regionIndex of this framework.

◆ getSealedStructuralFramework()

SealedSurfaceFrameworkRepresentation * resqml2::SealedVolumeFrameworkRepresentation::getSealedStructuralFramework ( ) const

Gets the sealed structural framework this sealed volume framework is based on.

Returns: The sealed structural framework this sealed volume framework is based on.

◆ getSideFlagOfExternalShellFace()

virtual bool resqml2::SealedVolumeFrameworkRepresentation::getSideFlagOfExternalShellFace	(	uint64_t	regionIndex,
		unsigned int	faceIndex ) const

pure virtual

Get the orientation (the side flag) of a particular face of the external shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `faceIndex >= getFaceCountOfExternalShell(regionIndex)`.

Parameters

regionIndex	Zero-based index of the framework region.
faceIndex	Zero-based index of the external shell face.

Returns: The side flag of the face faceIndex of the external shell of the region regionIndex of this framework.

◆ getSideFlagOfInternalShellFace()

virtual bool resqml2::SealedVolumeFrameworkRepresentation::getSideFlagOfInternalShellFace	(	uint64_t	regionIndex,
		unsigned int	internalShellIndex,
		unsigned int	faceIndex ) const

pure virtual

Get the orientation (the side flag) of a particular face of a particular internal shell of a particular region of this framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::out_of_range	If `internalShellIndex >= getInternalShellCount(regionIndex)`.
std::out_of_range	If `faceIndex >= getFaceCountOfInternalShell(regionIndex, internalShellIndex)`.

Parameters

regionIndex	Zero-based index of the framework region.
internalShellIndex	Zero-based index of the internal shell.
faceIndex	Zero-based index of the face.

Returns: The side flag of the face faceIndex of the internal shell internalShellIndex of the region regionIndex of this framework.

◆ getStratiUnitInterp()

class StratigraphicUnitInterpretation * resqml2::SealedVolumeFrameworkRepresentation::getStratiUnitInterp ( uint64_t regionIndex ) const

Gets the stratigraphic unit interpretation a particular region of this framework represents.

Exceptions

std::out_of_range If regionIndex >= getRegionCount().

Parameters

regionIndex Zero-based index of the region.

Returns: The stratigraphic unit interpretation represented by the region at position regionIndex.

◆ getXmlTag()

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

inlinefinalvirtual

Reimplemented from resqml2::RepresentationSetRepresentation.

◆ pushBackInternalShell()

virtual void resqml2::SealedVolumeFrameworkRepresentation::pushBackInternalShell	(	uint64_t	regionIndex,
		unsigned int	internalShellFaceCount,
		unsigned int const *	faceRepresentationIndices,
		unsigned int const *	faceRepPatchIndices,
		bool const *	faceSide )

pure virtual

Pushes back an internal shell in a particular volume region of this sealed volume framework.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::invalid_argument	If `externalShellFaceCount == 0`.

Parameters

regionIndex	Zero-base index of the volume region where to push back the internal shell.
internalShellFaceCount	The count of faces composing the region internal shell.
faceRepresentationIndices	An array containing, for each internal shell face, the index of the corresponding representation in the representation list of this organization. The size of this array is `internalShellFaceCount`.
faceRepPatchIndices	An array containing, for each internal shell face, the index of the corresponding patch in the corresponding representation. The size of this array is `internalShellFaceCount`.
faceSide	An array containing the orientation of each internal shell face. The positive orientation is defined with `true` while the negative one is defined with `false`. The size of this array is `internalShellFaceCount`.

◆ pushBackVolumeRegion()

virtual void resqml2::SealedVolumeFrameworkRepresentation::pushBackVolumeRegion	(	StratigraphicUnitInterpretation *	stratiUnitInterp,
		unsigned int	externalShellFaceCount,
		unsigned int const *	faceRepresentationIndices,
		unsigned int const *	faceRepPatchIndices,
		bool const *	faceSide )

pure virtual

Pushes back a volume region in this sealed volume framework.

Exceptions

std::invalid_argument	If `stratiUnitInterp == nullptr`.
std::invalid_argument	If `externalShellFaceCount == 0`.

Parameters

[in]	stratiUnitInterp	The stratigraphic unit interpretation represented by this region.
	externalShellFaceCount	The count of faces composing the region external shell.
	faceRepresentationIndices	An array containing, for each external shell face, the index of the corresponding representation in the representation list of this organization. The size of this array is `externalShellFaceCount`.
	faceRepPatchIndices	An array containing, for each external shell face, the index of the corresponding patch in the corresponding representation. The size of this array is `externalShellFaceCount`.
	faceSide	An array containing the orientation of each external shell face. The positive orientation is defined with `true` while the negative one is defined with `false`. The size of this array is `externalShellFaceCount`.

◆ setInterpretationOfVolumeRegion()

void resqml2::SealedVolumeFrameworkRepresentation::setInterpretationOfVolumeRegion	(	uint64_t	regionIndex,
		StratigraphicUnitInterpretation *	stratiUnitInterp )

Sets the stratigraphic unit interpretation of a particular volume region.

Exceptions

std::out_of_range	If `regionIndex >=` getRegionCount().
std::invalid_argument	If `stratiUnitInterp == nullptr`.

Parameters

	regionIndex	Zero-base index of the volume region.
[in]	stratiUnitInterp	The stratigraphic unit interpretation represented by the region at position `regionIndex`.

◆ setSealedSurfaceFramework()

void resqml2::SealedVolumeFrameworkRepresentation::setSealedSurfaceFramework ( SealedSurfaceFrameworkRepresentation * ssf )

Sets the sealed surface framework representation this sealed volume framework representation is based on.

Exceptions

std::invalid_argument If ssf == nullptr.

Parameters

[in] ssf The sealed surface framework representation to set.

Member Data Documentation

◆ XML_TAG

const char* resqml2::SealedVolumeFrameworkRepresentation::XML_TAG

static

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.9.0.1/src/resqml2/SealedVolumeFrameworkRepresentation.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SealedVolumeFrameworkRepresentation()

Member Function Documentation

◆ getFaceCountOfExternalShell()

◆ getFaceCountOfInternalShell()

◆ getInternalShellCount()

◆ getRegionCount()

◆ getRepOfExternalShellFace()

◆ getRepOfInternalShellFace()

◆ getRepPatchIndexOfExternalShellFace()

◆ getRepPatchIndexOfInternalShellFace()

◆ getSealedStructuralFramework()

◆ getSideFlagOfExternalShellFace()

◆ getSideFlagOfInternalShellFace()

◆ getStratiUnitInterp()

◆ getXmlTag()

◆ pushBackInternalShell()

◆ pushBackVolumeRegion()

◆ setInterpretationOfVolumeRegion()

◆ setSealedSurfaceFramework()

Member Data Documentation

◆ XML_TAG