Fesapi
2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
#include <SealedSurfaceFrameworkRepresentation.h>
Public Member Functions | |
SealedSurfaceFrameworkRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
SealedSurfaceFrameworkRepresentation (resqml2::StructuralOrganizationInterpretation *interp, const std::string &guid, const std::string &title) | |
Creates an instance of this class in a gsoap context. More... | |
SealedSurfaceFrameworkRepresentation (gsoap_eml2_3::_resqml22__SealedSurfaceFrameworkRepresentation *fromGsoap) | |
~SealedSurfaceFrameworkRepresentation ()=default | |
void | pushBackContact (gsoap_resqml2_0_1::resqml20__IdentityKind kind) final |
void | pushBackContact (gsoap_resqml2_0_1::resqml20__IdentityKind kind, unsigned int patchCount, unsigned int identicalNodesCount, int const *identicalNodes, eml2::AbstractHdfProxy *proxy) final |
void | pushBackContactPatch (unsigned int contactIdx, int const *nodeIndicesOnSupportingRepresentation, unsigned int nodeCount, resqml2::AbstractRepresentation *supportingRepresentation, eml2::AbstractHdfProxy *proxy) final |
unsigned int | getContactCount () const final |
gsoap_resqml2_0_1::resqml20__IdentityKind | getContactPatchIdentityKind (unsigned int contactIdx) const final |
bool | areAllContactPatchNodesIdentical (unsigned int contactIdx) const final |
unsigned int | getIdenticalContactPatchNodeCount (unsigned int contactIdx) const final |
void | getIdenticalContactPatchNodeIndices (unsigned int contactIdx, unsigned int *nodeIndices) const final |
unsigned int | getContactPatchCount (unsigned int contactIdx) const final |
resqml2::AbstractRepresentation * | getRepresentationOfContactPatch (unsigned int contactIdx, unsigned int cpIndex) const final |
unsigned int | getRepresentationIndexOfContactPatch (unsigned int contactIdx, unsigned int cpIndex) const final |
unsigned int | getContactPatchNodeCount (unsigned int contactIdx, unsigned int cpIndex) const final |
void | getContactPatchNodeIndices (unsigned int contactIdx, unsigned int cpIndex, unsigned int *nodeIndices) const final |
std::string | getXmlNamespace () const final |
Public Member Functions inherited from resqml2::SealedSurfaceFrameworkRepresentation | |
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, 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) |
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 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 | 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::SealedSurfaceFrameworkRepresentation | |
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) |
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.
|
inline |
Only to be used in partial transfer context
[in,out] | partialObject | If non-null, the partial object. |
resqml2_2::SealedSurfaceFrameworkRepresentation::SealedSurfaceFrameworkRepresentation | ( | resqml2::StructuralOrganizationInterpretation * | interp, |
const std::string & | guid, | ||
const std::string & | title | ||
) |
Creates an instance of this class in a gsoap context.
std::invalid_argument | If interp == nullptr . |
[in] | interp | The structural organization interpretation 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. |
|
inline |
Creates an instance of this class by wrapping a gsoap instance.
[in,out] | fromGsoap | If non-null, from gsoap. |
|
virtualdefault |
Destructor does nothing since the memory is managed by the gsoap context.
Reimplemented from resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Checks if all nodes of contact patches are identical in a particular contact.
std::out_of_range | If contactIdx is out of range. |
contactIdx | Zero-based index of the contact for which we want to check if all nodes of contact patches are identical. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the count of contacts in this framework.
std::range_error | If the count of contacts is strictly greater than unsigned int max. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the count of contact patches in a particular contact of this framework.
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. |
contactIdx | Zero-based index of the contact for which we look for the contact patches count. |
contactIdx
. Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the identity kind of a particular contact.
std::out_of_range | If contactIdx is out of range. |
contactIdx | Zero-based index of the contact for which we look for the identity kind. |
contactIdx
. Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Get the count of nodes of a particular contact patch.
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. |
contactIdx | Zero-based index of the contact in the contact list. |
cpIndex | Zero-based index of the contact patch in the contact. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
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()).
std::out_of_range | If contactIdx or cpIndex is out of range. |
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. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the count of identical nodes of a particular contact.
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. |
contactIdx | Zero-based index of the contact for which we look for the count of identical nodes. |
contactIdx
. Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the node indices of all contact patches which are identical in a particular contact.
std::invalid_argument | If all nodes of contact patches are identical (see areAllContactPatchNodesIdentical()). |
std::out_of_range | If contactIdx is out of range.*. |
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(). |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the representation index where a particular contact patch has been defined. The index is in the range [0..
getRepresentationCount()[
.
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. |
contactIdx | Zero-based index of the contact in the contact list. |
cpIndex | Zero-based index of the contact patch in the contact. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Gets the representation (for instance the triangulated surface) where a particular contact patch has been defined.
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. |
contactIdx | Zero-based index of the contact in the contact list. |
cpIndex | Zero-based index of the contact patch in the contact. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
inlinefinalvirtual |
Get the standard XML namespace for serializing this data object.
Implements common::AbstractObject.
|
finalvirtual |
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.
kind | The identity kind (colocation, previous colocation, equivalence or previous equivalence) of the contact to push. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
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.
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. |
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. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
finalvirtual |
Pushes back a contact patch in a particular contact of this structural framework.
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. |
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. |
Implements resqml2::SealedSurfaceFrameworkRepresentation.
|
static |
The standard XML namespace for serializing this data object.