Fesapi 2.14.0.0
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 resqml2::AbstractRepresentation common::AbstractObject resqml2_0_1::NonSealedSurfaceFrameworkRepresentation resqml2_2::NonSealedSurfaceFrameworkRepresentation

Public Member Functions

virtual ~NonSealedSurfaceFrameworkRepresentation ()=default
virtual void pushBackNonSealedContactRepresentation (unsigned int pointCount, double const *points, eml2::AbstractHdfProxy *proxy=nullptr, eml2::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 (uint64_t patchIndex) const override
void getXyzPointsOfPatch (uint64_t 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
Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()=default
eml2::AbstractLocal3dCrs * getLocalCrs (uint64_t patchIndex) const
virtual common::DataObjectReference getLocalCrsDor (uint64_t patchIndex) const
void setTimeIndex (uint64_t timeIndex, eml2::TimeSeries *timeSeries)
uint64_t getTimeIndex () const
 Gets the time index of this representation in the associated TimeSeries. Be sure to first check that a TimeSeries is associated this representation by calling getTimeSeriesDor or getTimeSeries;.
eml2::TimeSeries * getTimeSeries () const
common::DataObjectReference getTimeSeriesDor () const
 Gets the data object reference of the TimeSeries containing the time of this representation at a particular index. For now, this method only look for a TimeSeries at the first patch containing a point geometry.
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 (uint64_t patchIndex, double *xyzPoints) const
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS.
void getXyzPointsOfAllPatches (double *xyzPoints) const
 Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS.
bool isInSingleLocalCrs () const
bool isInSingleGlobalCrs () const
void getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
AbstractRepresentation * getSeismicSupportOfPatch (uint64_t patchIndex) const
std::set< AbstractRepresentation * > getAllSeismicSupport () const
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)
void addSeismic3dCoordinatesToPatch (uint64_t patchIndex, double *inlines, double *crosslines, uint64_t pointCount, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
void addSeismic3dCoordinatesToPatch (uint64_t patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)
void addSeismic2dCoordinatesToPatch (uint64_t patchIndex, double *lineAbscissa, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
void getSeismicLineAbscissaOfPointsOfPatch (uint64_t patchIndex, double *values) const
void getInlinesOfPointsOfPatch (uint64_t patchIndex, double *values) const
void getCrosslinesOfPointsOfPatch (uint64_t 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)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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)
uint64_t getAliasCount () const
std::string getAliasAuthorityAtIndex (uint64_t index) const
std::string getAliasTitleAtIndex (uint64_t index) const
std::vector< eml2::Activity * > getActivitySet () const
uint64_t getActivityCount () const
eml2::Activity * getActivity (uint64_t 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
uint64_t getExtraMetadataCount () const
std::string getExtraMetadataKeyAtIndex (uint64_t index) const
std::string getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string buildEtp12Uri () const
void setUriSource (const std::string &uriSource)
const std::string & getUriSource () const
std::string getEpcSourceFolder () const
void changeToPartialObject ()
template<>
int8_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const
template<>
uint8_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const
template<>
int16_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const
template<>
uint16_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const
template<>
int32_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const
template<>
uint32_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const
template<>
int64_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const
template<>
uint64_t readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const
template<>
int8_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const
template<>
uint8_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const
template<>
int16_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const
template<>
uint16_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const
template<>
int32_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const
template<>
uint32_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const
template<>
int64_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const
template<>
uint64_t readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const

Static Public Attributes

static constexpr char const * XML_TAG = "NonSealedSurfaceFrameworkRepresentation"
Static Public Attributes inherited from resqml2::RepresentationSetRepresentation
static const char * XML_TAG
Static Public Attributes inherited from resqml2::AbstractRepresentation
static constexpr char const * XML_TAG = "AbstractRepresentation"

Additional Inherited Members

Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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 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.

Reimplemented in resqml2_0_1::NonSealedSurfaceFrameworkRepresentation, and resqml2_2::NonSealedSurfaceFrameworkRepresentation.

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.

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

◆ getXmlTag()

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

Gets the standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

Reimplemented from resqml2::RepresentationSetRepresentation.

◆ pushBackNonSealedContactRepresentation()

virtual void resqml2::NonSealedSurfaceFrameworkRepresentation::pushBackNonSealedContactRepresentation ( unsigned int pointCount,
double const * points,
eml2::AbstractHdfProxy * proxy = nullptr,
eml2::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.

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

Member Data Documentation

◆ XML_TAG

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:
Generated by doxygen 1.15.0