Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::NonSealedSurfaceFrameworkRepresentation Class Referencefinal

#include <NonSealedSurfaceFrameworkRepresentation.h>

Inheritance diagram for resqml2_0_1::NonSealedSurfaceFrameworkRepresentation:
resqml2::NonSealedSurfaceFrameworkRepresentation resqml2::AbstractSurfaceFrameworkRepresentation resqml2::RepresentationSetRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 NonSealedSurfaceFrameworkRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 NonSealedSurfaceFrameworkRepresentation (resqml2::StructuralOrganizationInterpretation *interp, const std::string &guid, const std::string &title)
 Creates an instance of this class in a gsoap context. More...
 
 NonSealedSurfaceFrameworkRepresentation (gsoap_resqml2_0_1::_resqml20__NonSealedSurfaceFrameworkRepresentation *fromGsoap)
 
 ~NonSealedSurfaceFrameworkRepresentation ()=default
 
void pushBackNonSealedContactRepresentation (unsigned int pointCount, double const *points, eml2::AbstractHdfProxy *proxy=nullptr, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
unsigned int getContactCount () const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::NonSealedSurfaceFrameworkRepresentation
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::AbstractRepresentationgetRepresentation (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 AbstractLocal3dCrsgetLocalCrs (unsigned int patchIndex) const
 
virtual common::DataObjectReference getLocalCrsDor (unsigned int patchIndex) const
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () 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
 
AbstractRepresentationgetSeismicSupportOfPatch (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::DataObjectRepositorygetRepository () 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::ActivitygetActivity (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::NonSealedSurfaceFrameworkRepresentation
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)
 

Detailed Description

A non sealed surface framework representation.

Constructor & Destructor Documentation

◆ NonSealedSurfaceFrameworkRepresentation() [1/3]

resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::NonSealedSurfaceFrameworkRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ NonSealedSurfaceFrameworkRepresentation() [2/3]

resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::NonSealedSurfaceFrameworkRepresentation ( resqml2::StructuralOrganizationInterpretation interp,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf interp == nullptr.
Parameters
[in]interpThe structural organization interpretation the instance interprets.
guidThe guid to set to the horizon. If empty then a new guid will be generated.
titleA title for the instance to create.

◆ NonSealedSurfaceFrameworkRepresentation() [3/3]

resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::NonSealedSurfaceFrameworkRepresentation ( gsoap_resqml2_0_1::_resqml20__NonSealedSurfaceFrameworkRepresentation *  fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~NonSealedSurfaceFrameworkRepresentation()

resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::~NonSealedSurfaceFrameworkRepresentation ( )
virtualdefault

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

Reimplemented from resqml2::NonSealedSurfaceFrameworkRepresentation.

Member Function Documentation

◆ getContactCount()

unsigned int resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::getContactCount ( ) const
finalvirtual

Pushes back a contact patch in a particular contact representation of the structural framework.

Parameters
contactIndexThe index of the contact which will contain this contact patch.
nodeIndicesOnSupportingRepresentationThe nodes defining the contact patch on the supporting representation.
NodeCountThe node count of this contact patch.
supportingRepresentationThe supporting representation of this contact patch.
proxyThe hdf proxy for storing the nodes.

Implements resqml2::NonSealedSurfaceFrameworkRepresentation.

◆ getXmlNamespace()

std::string resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackNonSealedContactRepresentation()

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

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.

Implements resqml2::NonSealedSurfaceFrameworkRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::NonSealedSurfaceFrameworkRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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