A collection of contact, which are a list of contact patches and their identities. This collection of contact is completed by a set of representations gathered at the representation set representation level. More...

#include <SealedSurfaceFrameworkRepresentation.h>

Inheritance diagram for resqml2::SealedSurfaceFrameworkRepresentation:

Public Member Functions
virtual	~SealedSurfaceFrameworkRepresentation ()=default

virtual void	pushBackContact (gsoap_resqml2_0_1::resqml20__IdentityKind kind)=0

virtual void	pushBackContact (gsoap_resqml2_0_1::resqml20__IdentityKind kind, unsigned int patchCount, unsigned int identicalNodesCount, int const identicalNodes, eml2 ::AbstractHdfProxy proxy)=0

virtual void	pushBackContactPatch (unsigned int contactIdx, int const nodeIndicesOnSupportingRepresentation, uint64_t nodeCount, AbstractRepresentation supportingRepresentation, eml2 ::AbstractHdfProxy *proxy)=0

virtual unsigned int	getContactCount () const override=0

virtual gsoap_resqml2_0_1::resqml20__IdentityKind	getContactPatchIdentityKind (unsigned int contactIdx) const =0

virtual bool	areAllContactPatchNodesIdentical (unsigned int contactIdx) const =0

virtual unsigned int	getIdenticalContactPatchNodeCount (unsigned int contactIdx) const =0

virtual void	getIdenticalContactPatchNodeIndices (unsigned int contactIdx, unsigned int *nodeIndices) const =0

virtual unsigned int	getContactPatchCount (unsigned int contactIdx) const =0

virtual resqml2::AbstractRepresentation *	getRepresentationOfContactPatch (unsigned int contactIdx, unsigned int cpIndex) const =0

virtual unsigned int	getRepresentationIndexOfContactPatch (unsigned int contactIdx, unsigned int cpIndex) const =0

virtual unsigned int	getContactPatchNodeCount (unsigned int contactIdx, unsigned int cpIndex) const =0

virtual void	getContactPatchNodeIndices (unsigned int contactIdx, unsigned int cpIndex, unsigned int *nodeIndices) const =0

virtual std::string	getXmlTag () const final

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

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

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

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

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)

virtual void	loadTargetRelationships () override

Static Public Attributes
static constexpr char const *	XML_TAG = "SealedSurfaceFrameworkRepresentation"

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

Detailed Description

A collection of contact, which are a list of contact patches and their identities. This collection of contact is completed by a set of representations gathered at the representation set representation level.

Constructor & Destructor Documentation

◆ ~SealedSurfaceFrameworkRepresentation()

virtual resqml2::SealedSurfaceFrameworkRepresentation::~SealedSurfaceFrameworkRepresentation ( )

virtualdefault

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

Member Function Documentation

◆ areAllContactPatchNodesIdentical()

virtual bool resqml2::SealedSurfaceFrameworkRepresentation::areAllContactPatchNodesIdentical ( unsigned int contactIdx ) const

pure virtual

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

Exceptions

std::out_of_range If contactIdx is out of range.

Parameters

contactIdx Zero-based index of the contact for which we want to check if all nodes of contact patches are identical.

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

◆ getContactCount()

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

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

Implements resqml2::AbstractSurfaceFrameworkRepresentation.

◆ getContactPatchCount()

virtual unsigned int resqml2::SealedSurfaceFrameworkRepresentation::getContactPatchCount ( unsigned int contactIdx ) const

pure virtual

Gets the count of contact patches in a particular contact of this framework.

Exceptions

std::out_of_range	If `contactIdx` is out of range.
std::range_error	If the count of identical nodes is strictly greater than unsigned int max.

Parameters

contactIdx Zero-based index of the contact for which we look for the contact patches count.

Returns: The count of contact patches in the contact at position contactIdx.

◆ getContactPatchIdentityKind()

virtual gsoap_resqml2_0_1::resqml20__IdentityKind resqml2::SealedSurfaceFrameworkRepresentation::getContactPatchIdentityKind ( unsigned int contactIdx ) const

pure virtual

Gets the identity kind of a particular contact.

Exceptions

std::out_of_range If contactIdx is out of range.

Parameters

contactIdx Zero-based index of the contact for which we look for the identity kind.

Returns: The identity kind of the contact located at a contactIdx.

◆ getContactPatchNodeCount()

virtual unsigned int resqml2::SealedSurfaceFrameworkRepresentation::getContactPatchNodeCount	(	unsigned int	contactIdx,
		unsigned int	cpIndex ) const

pure virtual

Get the count of nodes of a particular contact patch.

Exceptions

std::out_of_range	If `contactIdx` or `cpIndex` is out of range.
std::range_error	If the count of nodes is strictly greater than unsigned int max.

Parameters

contactIdx	Zero-based index of the contact in the contact list.
cpIndex	Zero-based index of the contact patch in the contact.

Returns: The count of nodes of a particular contact patch.

◆ getContactPatchNodeIndices()

virtual void resqml2::SealedSurfaceFrameworkRepresentation::getContactPatchNodeIndices	(	unsigned int	contactIdx,
		unsigned int	cpIndex,
		unsigned int *	nodeIndices ) const

pure virtual

Gets the nodes indices of a particular contact patch. The returned indices are associated to the node array of the representation of the particular contact patch (see getRepresentationOfContactPatch()).

Exceptions

std::out_of_range If contactIdx or cpIndex is out of range.

Parameters

	contactIdx	Zero-based index of the contact in the contact list.
	cpIndex	Zero-based index of the contact patch in the contact.
[out]	nodeIndices	An array to received the nodes indices. This array must be preallocated with getContactPatchNodeCount(). It won't be deleted by fesapi.

◆ getIdenticalContactPatchNodeCount()

virtual unsigned int resqml2::SealedSurfaceFrameworkRepresentation::getIdenticalContactPatchNodeCount ( unsigned int contactIdx ) const

pure virtual

Gets the count of identical nodes of a particular contact.

Exceptions

std::invalid_argument	If all nodes of contact patches are identical (see areAllContactPatchNodesIdentical()).
std::out_of_range	If `contactIdx` is out of range.
std::range_error	If the count of identical nodes is strictly greater than unsigned int max.

Parameters

contactIdx Zero-based index of the contact for which we look for the count of identical nodes.

Returns: The count of identical nodes in the contact at position contactIdx.

◆ getIdenticalContactPatchNodeIndices()

virtual void resqml2::SealedSurfaceFrameworkRepresentation::getIdenticalContactPatchNodeIndices	(	unsigned int	contactIdx,
		unsigned int *	nodeIndices ) const

pure virtual

Gets the node indices of all contact patches which are identical in a particular contact.

Exceptions

std::invalid_argument	If all nodes of contact patches are identical (see areAllContactPatchNodesIdentical()).
std::out_of_range	If `contactIdx` is out of range.*.

Parameters

	contactIdx	Zero-based index of the contact for which we look for the identical nodes indices.
[out]	nodeIndices	An array to receive the identical nodes indices. This array must be preallocated with getIdenticalContactPatchNodeCount().

◆ getRepresentationIndexOfContactPatch()

virtual unsigned int resqml2::SealedSurfaceFrameworkRepresentation::getRepresentationIndexOfContactPatch	(	unsigned int	contactIdx,
		unsigned int	cpIndex ) const

pure virtual

Gets the representation index where a particular contact patch has been defined. The index is in the range [0..getRepresentationCount()[.

Exceptions

std::out_of_range	If `contactIdx` or `cpIndex` is out of range.
std::range_error	If the representation index is strictly greater than unsigned int max.

Parameters

contactIdx	Zero-based index of the contact in the contact list.
cpIndex	Zero-based index of the contact patch in the contact.

Returns: The representation index where the contact patch has been defined.

◆ getRepresentationOfContactPatch()

virtual resqml2::AbstractRepresentation * resqml2::SealedSurfaceFrameworkRepresentation::getRepresentationOfContactPatch	(	unsigned int	contactIdx,
		unsigned int	cpIndex ) const

pure virtual

Gets the representation (for instance the triangulated surface) where a particular contact patch has been defined.

Exceptions

std::out_of_range	If `contactIdx` or `cpIndex` is out of range.
std::range_error	If the index of the representation provided in the contact patch is strictly greater than unsigned int max.

Parameters

contactIdx	Zero-based index of the contact in the contact list.
cpIndex	Zero-based index of the contact patch in the contact.

Returns: The representation where the contact patch has been defined.

◆ getXmlTag()

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

inlinefinalvirtual

Reimplemented from resqml2::RepresentationSetRepresentation.

◆ pushBackContact() [1/2]

virtual void resqml2::SealedSurfaceFrameworkRepresentation::pushBackContact ( gsoap_resqml2_0_1::resqml20__IdentityKind kind )

pure virtual

Pushes back a contact in this structural framework with implicit identical nodes. After calling the following method, the contact patches container of the newly pushed contact remains empty. After this call, do not forget to call the pushBackContactPatch() method for each contact patch of the contact.

Parameters

kind	The identity kind (colocation, previous colocation, equivalence or previous equivalence) of the contact to push.

◆ pushBackContact() [2/2]

virtual void resqml2::SealedSurfaceFrameworkRepresentation::pushBackContact	(	gsoap_resqml2_0_1::resqml20__IdentityKind	kind,
		unsigned int	patchCount,
		unsigned int	identicalNodesCount,
		int const *	identicalNodes,
		eml2 ::AbstractHdfProxy *	proxy )

pure virtual

Pushes back a contact in this structural framework.After calling the following method, the contact patches container of the newly pushed contact remains empty. After this call, do not forget to call the pushBackContactPatch() method for each contact patch of the contact.

Exceptions

std::invalid_argument	If `patchCount` is strictly lesser than `2`.
std::invalid_argument	If `identicalNodesCount` is `0`.
std::invalid_argument	If `identicalNodes` is `nullptr`.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.

Parameters

	kind	The identity kind (colocation, previous colocation, equivalence or previous equivalence) of the contact to push.
	patchCount	The number of contact patches within this sealed contact.
	identicalNodesCount	The number of identical nodes along this sealed contact.
[in]	identicalNodes	A 1d array of identical nodes indices. The size of this array is `patchCount` `*` `identicalNodesCount`. It indicates which nodes (identified by their common index in all contact patches) of the contact patches are identical.
[in,out]	proxy	The HDF proxy where to write the `identicalNodes` values. If `nullptr`, then a default HDF proxy must be defined in the repository.

◆ pushBackContactPatch()

virtual void resqml2::SealedSurfaceFrameworkRepresentation::pushBackContactPatch	(	unsigned int	contactIdx,
		int const *	nodeIndicesOnSupportingRepresentation,
		uint64_t	nodeCount,
		AbstractRepresentation *	supportingRepresentation,
		eml2 ::AbstractHdfProxy *	proxy )

pure virtual

Pushes back a contact patch in a particular contact of this structural framework.

Exceptions

std::invalid_argument	If `nodeIndicesOnSupportingRepresentation` is `nullptr`.
std::invalid_argument	If `nodeCount` is `0`.
std::invalid_argument	If `supportingRepresentation` is `nullptr` or if it is not referenced by this sealed surface framework.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.
std::out_of_range	If `contactIdx` is out of range.

Parameters

	contactIdx	Zero-base index of the contact which will contain this contact patch.
	nodeIndicesOnSupportingRepresentation	The nodes defining the contact patch on the supporting representation. Size if `nodeCount`.
	nodeCount	The node count of this contact patch.
[in]	supportingRepresentation	The supporting representation of this contact patch.
[in,out]	proxy	The HDF proxy where to write the `nodeIndicesOnSupportingRepresentation` values. If `nullptr`, then a default HDF proxy must be defined in the repository.

Member Data Documentation

◆ XML_TAG

constexpr char const* resqml2::SealedSurfaceFrameworkRepresentation::XML_TAG = "SealedSurfaceFrameworkRepresentation"

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

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SealedSurfaceFrameworkRepresentation()

Member Function Documentation

◆ areAllContactPatchNodesIdentical()

◆ getContactCount()

◆ getContactPatchCount()

◆ getContactPatchIdentityKind()

◆ getContactPatchNodeCount()

◆ getContactPatchNodeIndices()

◆ getIdenticalContactPatchNodeCount()

◆ getIdenticalContactPatchNodeIndices()

◆ getRepresentationIndexOfContactPatch()

◆ getRepresentationOfContactPatch()

◆ getXmlTag()

◆ pushBackContact() [1/2]

◆ pushBackContact() [2/2]

◆ pushBackContactPatch()

Member Data Documentation

◆ XML_TAG