Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2::NonSealedSurfaceFrameworkRepresentation Class Referenceabstract

A non sealed surface framework representation is collection of contact representations parts, which are a list of contact patches with no identity. This collection of contact representations is completed by a set of representations gathered at the representation set representation level. More...

#include <NonSealedSurfaceFrameworkRepresentation.h>

Inheritance diagram for resqml2::NonSealedSurfaceFrameworkRepresentation:
resqml2::AbstractSurfaceFrameworkRepresentation resqml2::RepresentationSetRepresentation

Public Member Functions

virtual ~NonSealedSurfaceFrameworkRepresentation ()=default
 
virtual void pushBackNonSealedContactRepresentation (unsigned int pointCount, double const *points, eml2 ::AbstractHdfProxy *proxy=nullptr, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr)=0
 
virtual unsigned int getContactCount () const override=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::AbstractRepresentationgetRepresentation (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 = "NonSealedSurfaceFrameworkRepresentation"
 
- Static Public Attributes inherited from resqml2::RepresentationSetRepresentation
static const char * XML_TAG
 

Detailed Description

A non sealed surface framework representation is collection of contact representations parts, which are a list of contact patches with no identity. This collection of contact representations is completed by a set of representations gathered at the representation set representation level.

Constructor & Destructor Documentation

◆ ~NonSealedSurfaceFrameworkRepresentation()

virtual resqml2::NonSealedSurfaceFrameworkRepresentation::~NonSealedSurfaceFrameworkRepresentation ( )
virtualdefault

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

Member Function Documentation

◆ getContactCount()

virtual unsigned int resqml2::NonSealedSurfaceFrameworkRepresentation::getContactCount ( ) const
overridepure virtual

Gets the count of contacts in this framework.

Exceptions
std::range_errorIf the count of contacts is strictly greater than unsigned int max.
Returns
The count of contacts in this framework.

Implements resqml2::AbstractSurfaceFrameworkRepresentation.

◆ getXmlTag()

virtual std::string resqml2::NonSealedSurfaceFrameworkRepresentation::getXmlTag ( ) const
inlinefinalvirtual

◆ pushBackNonSealedContactRepresentation()

virtual void resqml2::NonSealedSurfaceFrameworkRepresentation::pushBackNonSealedContactRepresentation ( unsigned int pointCount,
double const * points,
eml2 ::AbstractHdfProxy * proxy = nullptr,
resqml2 ::AbstractLocal3dCrs * localCrs = nullptr )
pure virtual

Pushes back a contact representation in this structural framework

Exceptions
std::invalid_argumentIf pointCount is 0.
std::invalid_argumentIf points is nullptr.
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf localCrs is nullptr and no default local 3d CRS is defined in the repository.
Parameters
pointCountThe number of points in the contact representation.
[in]pointsThe (x, y, z) points of the contact representation. Count is pointCount * 3 and for each contact point (x, y, z) = (points[2i], points[2i+1], points[2i+2]).
[in,out]proxy(Optional) The HDF proxy where the numerical values (contact points coordinates) are stored. If nullptr (default), then the default HDF proxy of the repository will be used.
[in,out]localCrs(Optional) The local 3d CRS on which the geometry of the contact representation is based on. If nullptr (default), then the default local 3d CRS of the repository will be used.

Member Data Documentation

◆ XML_TAG

constexpr char const* resqml2::NonSealedSurfaceFrameworkRepresentation::XML_TAG = "NonSealedSurfaceFrameworkRepresentation"
staticconstexpr

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


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