Parent class for a sealed or non-sealed surface framework representation. Each one instantiates a representation set representation. The difference between the sealed and non- sealed frameworks is that, in the non-sealed case, we do not have all of the contacts, or we have all of the contacts but they are not all sealed. More...

#include <AbstractSurfaceFrameworkRepresentation.h>

Inheritance diagram for resqml2::AbstractSurfaceFrameworkRepresentation:

Public Member Functions
virtual	~AbstractSurfaceFrameworkRepresentation ()=default

void	pushBackContactIdentity (gsoap_resqml2_0_1::resqml20__IdentityKind kind, unsigned int contactCount, int const contactIndices, eml2::AbstractHdfProxy proxy)

void	pushBackContactIdentity (gsoap_resqml2_0_1::resqml20__IdentityKind kind, unsigned int contactCount, int const contactIndices, unsigned int identicalNodesCount, int const identicalNodesIndexes, eml2::AbstractHdfProxy *proxy)

virtual unsigned int	getContactCount () const =0

unsigned int	getContactIdentityCount () const

gsoap_resqml2_0_1::resqml20__IdentityKind	getContactIdentityKind (unsigned int ciIndex) const

unsigned int	getContactCountInContactIdentity (unsigned int ciIndex) const

void	getContactIndices (unsigned int ciIndex, unsigned int *contactRepIndices) const

bool	areAllContactNodesIdentical (unsigned int ciIndex) const

unsigned int	getIdenticalContactNodeCount (unsigned int ciIndex) const

void	getIdenticalContactNodeIndices (unsigned int ciIndex, unsigned int *nodeIndices) const

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)

virtual std::string	getXmlTag () const override

virtual void	loadTargetRelationships () override

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

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

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)

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

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

Detailed Description

Parent class for a sealed or non-sealed surface framework representation. Each one instantiates a representation set representation. The difference between the sealed and non- sealed frameworks is that, in the non-sealed case, we do not have all of the contacts, or we have all of the contacts but they are not all sealed.

Constructor & Destructor Documentation

◆ ~AbstractSurfaceFrameworkRepresentation()

virtual resqml2::AbstractSurfaceFrameworkRepresentation::~AbstractSurfaceFrameworkRepresentation ( )

virtualdefault

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

Member Function Documentation

◆ areAllContactNodesIdentical()

bool resqml2::AbstractSurfaceFrameworkRepresentation::areAllContactNodesIdentical ( unsigned int ciIndex ) const

Checks if all nodes of contacts are identical in a particular contact identity.

Exceptions

std::out_of_range	If `ciIndex` is out of range.
std::logic_error	If the RESQML version is unknown.

Parameters

ciIndex Zero-based index of the contact identity in the contact identity list.

Returns: True if all nodes of contacts are identical else false.

◆ getContactCount()

virtual unsigned int resqml2::AbstractSurfaceFrameworkRepresentation::getContactCount ( ) const

pure virtual

Gets the count of contacts in this framework.

Exceptions

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

Returns: The count of contacts in this framework.

Implemented in resqml2::SealedSurfaceFrameworkRepresentation, resqml2::NonSealedSurfaceFrameworkRepresentation, resqml2_2::SealedSurfaceFrameworkRepresentation, resqml2_2::NonSealedSurfaceFrameworkRepresentation, resqml2_0_1::SealedSurfaceFrameworkRepresentation, and resqml2_0_1::NonSealedSurfaceFrameworkRepresentation.

◆ getContactCountInContactIdentity()

unsigned int resqml2::AbstractSurfaceFrameworkRepresentation::getContactCountInContactIdentity ( unsigned int ciIndex ) const

Gets the count of contacts of a particular contact identity.

Exceptions

std::out_of_range	If `ciIndex` is out of range.
std::range_error	If the count of contacts is strictly greater than unsigned int max.
std::logic_error	If the RESQML version is unknown.

Parameters

ciIndex Zero-based index of the contact identity in the contact identity list.

Returns: The count of contacts of the contact identity at position ciIndex.

◆ getContactIdentityCount()

unsigned int resqml2::AbstractSurfaceFrameworkRepresentation::getContactIdentityCount ( ) const

Gets the count of contact identities in this framework.

Exceptions

std::range_error If the count of contacts identities is strictly greater than unsigned int max.

Returns: The count of contact identities in this framework.

◆ getContactIdentityKind()

gsoap_resqml2_0_1::resqml20__IdentityKind resqml2::AbstractSurfaceFrameworkRepresentation::getContactIdentityKind ( unsigned int ciIndex ) const

Gets the kind of a contact identity located at a particular index.

Exceptions

std::out_of_range	If `ciIndex` is out of range.
std::logic_error	If the RESQML version is unknown.

Parameters

ciIndex Zero-based index of the contact identity in the contact identity list.

Returns: The kind of the contact identity at position ciIndex in the contact identity list.

◆ getContactIndices()

void resqml2::AbstractSurfaceFrameworkRepresentation::getContactIndices	(	unsigned int	ciIndex,
		unsigned int *	contactRepIndices
	)		const

Gets the contact indices of a particular contact identity. The returned indices are in the interval [0..getContactCount()[.

Exceptions

std::out_of_range	If `ciIndex` is out of range.
std::logic_error	If the RESQML version is unknown.

Parameters

	ciIndex	Zero-based index of the contact identity in the contact identity list.
[out]	contactRepIndices	An array to receive contact indices. It must be preallocated with getContactCountInContactIdentity(). It won't be deleted by fesapi.

◆ getIdenticalContactNodeCount()

unsigned int resqml2::AbstractSurfaceFrameworkRepresentation::getIdenticalContactNodeCount ( unsigned int ciIndex ) const

Gets the count of all identical nodes of a particular contact identity.

Exceptions

std::invalid_argument	If all nodes are identical (see areAllContactNodesIdentical()).
std::out_of_range	If `ciIndex` is out of range.
std::logic_error	If the RESQML version is unknown.
std::range_error	If the count of identical nodes is strictly greater than `unsigned int` max.

Parameters

ciIndex Zero-based index of the contact identity in the contact identity list.

Returns: The count of identical nodes of a particular contact identity.

◆ getIdenticalContactNodeIndices()

void resqml2::AbstractSurfaceFrameworkRepresentation::getIdenticalContactNodeIndices	(	unsigned int	ciIndex,
		unsigned int *	nodeIndices
	)		const

Gets the indices of all identical nodes of a particular contact identity.

Exceptions

std::invalid_argument	If if all nodes are identical (see areAllContactRepNodesIdenticalInContactIdentity()).
std::out_of_range	If `ciIndex` is out of range.
std::logic_error	If the RESQML version is unknown.

Parameters

	ciIndex	ciIndex Zero-based index of the contact identity in the contact identity list.
[out]	nodeIndices	An array to receive the identical nodes indices. It must be preallocated with a count of getIdenticalContactNodeCount(). It won't be deleted by fesapi.

◆ pushBackContactIdentity() [1/2]

void resqml2::AbstractSurfaceFrameworkRepresentation::pushBackContactIdentity	(	gsoap_resqml2_0_1::resqml20__IdentityKind	kind,
		unsigned int	contactCount,
		int const *	contactIndices,
		eml2::AbstractHdfProxy *	proxy
	)

Pushes back a contact identity in this structural framework with implicit identical nodes.

Exceptions

std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.
std::logic_error	If the RESQML version is unknown.

Parameters

	kind	The identity kind (colocation, previous colocation, equivalence or previous equivalence).
	contactCount	The number of sealed contact representations involved within the identity.
	contactIndices	The indices of the sealed contact representations involved within the identity. Count is `contactCount`.
[in,out]	proxy	The HDF proxy where to write the `contactIndices` values. If `nullptr`, then a default HDF proxy must be defined in the repository.

◆ pushBackContactIdentity() [2/2]

void resqml2::AbstractSurfaceFrameworkRepresentation::pushBackContactIdentity	(	gsoap_resqml2_0_1::resqml20__IdentityKind	kind,
		unsigned int	contactCount,
		int const *	contactIndices,
		unsigned int	identicalNodesCount,
		int const *	identicalNodesIndexes,
		eml2::AbstractHdfProxy *	proxy
	)

Push back a contact identity in this structural framework.

Exceptions

std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.
std::logic_error	If the RESQML version is unknown.

Parameters

	kind	The identity kind (colocation, previous colocation, equivalence or previous equivalence).
	contactCount	The number of sealed contact representations involved within the identity.
	contactIndices	The indices of the sealed contact representations involved within the identity. Count is `contactCount`.
	identicalNodesCount	The number of identical nodes.
	identicalNodesIndexes	Indicates which nodes (identified by their common index in all contact representations) of the contact representations are identical. Count is `identicalNodesCount`.
[in,out]	proxy	The HDF proxy where to write the `contactIndices` and `identicalNodesIndexes` values. Id f `nullptr`, then a default HDF proxy must be defined in the repository.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2/AbstractSurfaceFrameworkRepresentation.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractSurfaceFrameworkRepresentation()

Member Function Documentation

◆ areAllContactNodesIdentical()

◆ getContactCount()

◆ getContactCountInContactIdentity()

◆ getContactIdentityCount()

◆ getContactIdentityKind()

◆ getContactIndices()

◆ getIdenticalContactNodeCount()

◆ getIdenticalContactNodeIndices()

◆ pushBackContactIdentity() [1/2]

◆ pushBackContactIdentity() [2/2]