#include <SealedVolumeFrameworkRepresentation.h>

Inheritance diagram for resqml2_0_1::SealedVolumeFrameworkRepresentation:

Public Member Functions
	SealedVolumeFrameworkRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	SealedVolumeFrameworkRepresentation (resqml2::StratigraphicColumnRankInterpretation interp, const std::string &guid, const std::string &title, resqml2::SealedSurfaceFrameworkRepresentation ssf)
	Creates an instance of this class in a gsoap context. More...

	SealedVolumeFrameworkRepresentation (gsoap_resqml2_0_1::_resqml20__SealedVolumeFrameworkRepresentation *fromGsoap)

	~SealedVolumeFrameworkRepresentation ()=default

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

void	pushBackInternalShell (unsigned int regionIndex, unsigned int externalShellFaceCount, unsigned int const faceRepresentationIndices, unsigned int const faceRepPatchIndices, bool const *faceSide) final

unsigned int	getRegionCount () const final

unsigned int	getInternalShellCount (unsigned int regionIndex) const final

unsigned int	getFaceCountOfExternalShell (unsigned int regionIndex) const final

unsigned int	getFaceCountOfInternalShell (unsigned int regionIndex, unsigned int internalShellIndex) const final

resqml2::AbstractRepresentation *	getRepOfExternalShellFace (unsigned int regionIndex, unsigned int faceIndex) const final

resqml2::AbstractRepresentation *	getRepOfInternalShellFace (unsigned int regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const final

unsigned int	getRepPatchIndexOfExternalShellFace (unsigned int regionIndex, unsigned int faceIndex) const final

unsigned int	getRepPatchIndexOfInternalShellFace (unsigned int regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const final

bool	getSideFlagOfExternalShellFace (unsigned int regionIndex, unsigned int faceIndex) const final

bool	getSideFlagOfInternalShellFace (unsigned int regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const final

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::SealedVolumeFrameworkRepresentation
void	setSealedSurfaceFramework (SealedSurfaceFrameworkRepresentation *ssf)

void	setInterpretationOfVolumeRegion (unsigned int regionIndex, StratigraphicUnitInterpretation *stratiUnitInterp)

SealedSurfaceFrameworkRepresentation *	getSealedStructuralFramework () const

class StratigraphicUnitInterpretation *	getStratiUnitInterp (unsigned int regionIndex) const

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

unsigned int	getPatchCount () const override

bool	isHomogeneous () const

unsigned int	getRepresentationCount () const

resqml2::AbstractRepresentation *	getRepresentation (unsigned int index) const

common::DataObjectReference	getRepresentationDor (unsigned int index) const

void	pushBack (resqml2::AbstractRepresentation *rep)

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

std::vector< class AbstractProperty * >	getPropertySet () const

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

uint64_t	getXyzPointCountOfAllPatches () const

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

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

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

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

Static Public Attributes
static const char *	XML_NS

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

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

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

Additional Inherited Members
Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement { NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 , PILLAR = 4 }

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)

Detailed Description

A sealed volume framework representation.

Constructor & Destructor Documentation

◆ SealedVolumeFrameworkRepresentation() [1/3]

resqml2_0_1::SealedVolumeFrameworkRepresentation::SealedVolumeFrameworkRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ SealedVolumeFrameworkRepresentation() [2/3]

resqml2_0_1::SealedVolumeFrameworkRepresentation::SealedVolumeFrameworkRepresentation	(	resqml2::StratigraphicColumnRankInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		resqml2::SealedSurfaceFrameworkRepresentation *	ssf
	)

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If interp == nullptr or ssf == nullptr.

Parameters

[in]	interp	The Stratigraphic Column Rank Interpretation which the instance interprets.
	guid	The guid to set to the representation. If empty then a new guid will be generated.
	title	A title for the instance to create.
[in]	ssf	The Sealed Surface Framework which this instance is based on.

◆ SealedVolumeFrameworkRepresentation() [3/3]

resqml2_0_1::SealedVolumeFrameworkRepresentation::SealedVolumeFrameworkRepresentation ( gsoap_resqml2_0_1::_resqml20__SealedVolumeFrameworkRepresentation * fromGsoap )

inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~SealedVolumeFrameworkRepresentation()

resqml2_0_1::SealedVolumeFrameworkRepresentation::~SealedVolumeFrameworkRepresentation ( )

virtualdefault

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

Reimplemented from resqml2::SealedVolumeFrameworkRepresentation.

Member Function Documentation

◆ getFaceCountOfExternalShell()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getFaceCountOfExternalShell ( unsigned int regionIndex ) const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getFaceCountOfInternalShell()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getFaceCountOfInternalShell	(	unsigned int	regionIndex,
		unsigned int	internalShellIndex
	)		const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getInternalShellCount()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getInternalShellCount ( unsigned int regionIndex ) const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getRegionCount()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getRegionCount ( ) const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getRepOfExternalShellFace()

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

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getRepOfInternalShellFace()

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

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getRepPatchIndexOfExternalShellFace()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getRepPatchIndexOfExternalShellFace	(	unsigned int	regionIndex,
		unsigned int	faceIndex
	)		const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getRepPatchIndexOfInternalShellFace()

unsigned int resqml2_0_1::SealedVolumeFrameworkRepresentation::getRepPatchIndexOfInternalShellFace	(	unsigned int	regionIndex,
		unsigned int	internalShellIndex,
		unsigned int	faceIndex
	)		const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getSideFlagOfExternalShellFace()

bool resqml2_0_1::SealedVolumeFrameworkRepresentation::getSideFlagOfExternalShellFace	(	unsigned int	regionIndex,
		unsigned int	faceIndex
	)		const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getSideFlagOfInternalShellFace()

bool resqml2_0_1::SealedVolumeFrameworkRepresentation::getSideFlagOfInternalShellFace	(	unsigned int	regionIndex,
		unsigned int	internalShellIndex,
		unsigned int	faceIndex
	)		const

finalvirtual

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.

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ getXmlNamespace()

std::string resqml2_0_1::SealedVolumeFrameworkRepresentation::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackInternalShell()

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

finalvirtual

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

Implements resqml2::SealedVolumeFrameworkRepresentation.

◆ pushBackVolumeRegion()

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

finalvirtual

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

Implements resqml2::SealedVolumeFrameworkRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::SealedVolumeFrameworkRepresentation::XML_NS

static

The standard 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.0.0.0/src/resqml2_0_1/SealedVolumeFrameworkRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SealedVolumeFrameworkRepresentation() [1/3]

◆ SealedVolumeFrameworkRepresentation() [2/3]

◆ SealedVolumeFrameworkRepresentation() [3/3]

◆ ~SealedVolumeFrameworkRepresentation()

Member Function Documentation

◆ getFaceCountOfExternalShell()

◆ getFaceCountOfInternalShell()

◆ getInternalShellCount()

◆ getRegionCount()

◆ getRepOfExternalShellFace()

◆ getRepOfInternalShellFace()

◆ getRepPatchIndexOfExternalShellFace()

◆ getRepPatchIndexOfInternalShellFace()

◆ getSideFlagOfExternalShellFace()

◆ getSideFlagOfInternalShellFace()

◆ getXmlNamespace()

◆ pushBackInternalShell()

◆ pushBackVolumeRegion()

Member Data Documentation

◆ XML_NS