Fesapi 2.10.1.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
A strict boundary representation (BREP), which represents the volume region by assembling together shells. More...
#include <SealedVolumeFrameworkRepresentation.h>
Public Member Functions | |
virtual | ~SealedVolumeFrameworkRepresentation ()=default |
void | setSealedSurfaceFramework (SealedSurfaceFrameworkRepresentation *ssf) |
void | setInterpretationOfVolumeRegion (uint64_t regionIndex, StratigraphicUnitInterpretation *stratiUnitInterp) |
virtual void | pushBackVolumeRegion (StratigraphicUnitInterpretation *stratiUnitInterp, unsigned int externalShellFaceCount, unsigned int const *faceRepresentationIndices, unsigned int const *faceRepPatchIndices, bool const *faceSide)=0 |
virtual void | pushBackInternalShell (uint64_t regionIndex, unsigned int internalShellFaceCount, unsigned int const *faceRepresentationIndices, unsigned int const *faceRepPatchIndices, bool const *faceSide)=0 |
SealedSurfaceFrameworkRepresentation * | getSealedStructuralFramework () const |
class StratigraphicUnitInterpretation * | getStratiUnitInterp (uint64_t regionIndex) const |
virtual uint64_t | getRegionCount () const =0 |
virtual uint64_t | getInternalShellCount (uint64_t regionIndex) const =0 |
virtual uint64_t | getFaceCountOfExternalShell (uint64_t regionIndex) const =0 |
virtual uint64_t | getFaceCountOfInternalShell (uint64_t regionIndex, unsigned int internalShellIndex) const =0 |
virtual resqml2::AbstractRepresentation * | getRepOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0 |
virtual resqml2::AbstractRepresentation * | getRepOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0 |
virtual uint64_t | getRepPatchIndexOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0 |
virtual uint64_t | getRepPatchIndexOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0 |
virtual bool | getSideFlagOfExternalShellFace (uint64_t regionIndex, unsigned int faceIndex) const =0 |
virtual bool | getSideFlagOfInternalShellFace (uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const =0 |
virtual std::string | getXmlTag () const final |
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) |
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 (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. | |
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 (const unsigned int &patchIndex) const |
std::set< AbstractRepresentation * > | getAllSeismicSupport () const |
void | pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet) |
void | addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double *inlines, double *crosslines, uint64_t 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) |
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 |
unsigned int | getExtraMetadataCount () const |
std::string | getExtraMetadataKeyAtIndex (unsigned int index) const |
std::string | getExtraMetadataStringValueAtIndex (unsigned int index) const |
std::string | buildEtp12Uri () const |
void | setUriSource (const std::string &uriSource) |
const std::string & | getUriSource () const |
std::string | getEpcSourceFolder () const |
void | changeToPartialObject () |
Static Public Attributes | |
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 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) |
A strict boundary representation (BREP), which represents the volume region by assembling together shells.
BUSINESS RULE: The sealed structural framework must be part of the same earth model as this sealed volume framework.
|
virtualdefault |
Destructor does nothing since the memory is managed by the gSOAP context.
Reimplemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the count of faces in a particular region external shell.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::range_error | If the count of faces is strictly greater than unsigned int max. |
regionIndex | Zero-based index of the framework region. |
regionIndex
. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the count of faces in a particular region internal shell.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If internalShellIndex >= getInternalShellCount(regionIndex) . |
std::range_error | If the count of faces is strictly greater than unsigned int max. |
regionIndex | Zero-based index of the region. |
internalShellIndex | Zero-based index of the internal shell. |
regionIndex
internal shell internalShellIndex
. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the count of internal shells in a particular region.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::range_error | If the count of internal shells is strictly greater than unsigned int max. |
regionIndex | Zero-based index of the framework region. |
regionIndex
. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the count of regions in this framework.
std::range_error | If the count of regions is strictly greater than unsigned int. |
Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the representation (for instance the triangulated surface) which contains a particular face of the external shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If faceIndex >= getFaceCountOfExternalShell(regionIndex) . |
regionIndex | Zero-based index of the region. |
faceIndex | Zero-base index of the external shell face. |
faceIndex
of the external shell of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Gets the representation (for instance the triangulated surface) which contains a particular face of a particular internal shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If internalShellIndex >= getInternalShellCount(regionIndex) . |
std::out_of_range | If faceIndex >= getFaceCountOfInternalShell(regionIndex,
internalShellIndex) . |
regionIndex | Zero-based index of the framework region. |
internalShellIndex | Zero-based index of the internal shell. |
faceIndex | Zero-based index of the face of the framework region internal shell. |
faceIndex
of the internal shell internalShellIndex
of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Get the representation patch index corresponding to a particular face of the external shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If faceIndex >= getFaceCountOfExternalShell(regionIndex) . |
regionIndex | Zero-based index of the framework region. |
faceIndex | Zero-based index of the external shell face. |
getRepOfExternalShellFace(regionIndex, faceIndex)
) which is the face faceIndex
of the external shell of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Get the representation patch index corresponding to a particular face of particular internal shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If internalShellIndex >= getInternalShellCount(regionIndex) . |
std::out_of_range | If faceIndex >= getFaceCountOfInternalShell(regionIndex,
internalShellIndex) . |
regionIndex | Zero-based index of the framework region. |
internalShellIndex | Zero-based index of the internal shell. |
faceIndex | Zero-based index of the face. |
getRepOfInternalShellFace(regionIndex, internalShellIndex, faceIndex)
) which is the face faceIndex
of the internal shell internalShellIndex
of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
SealedSurfaceFrameworkRepresentation * resqml2::SealedVolumeFrameworkRepresentation::getSealedStructuralFramework | ( | ) | const |
Gets the sealed structural framework this sealed volume framework is based on.
|
pure virtual |
Get the orientation (the side flag) of a particular face of the external shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If faceIndex >= getFaceCountOfExternalShell(regionIndex) . |
regionIndex | Zero-based index of the framework region. |
faceIndex | Zero-based index of the external shell face. |
faceIndex
of the external shell of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Get the orientation (the side flag) of a particular face of a particular internal shell of a particular region of this framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::out_of_range | If internalShellIndex >= getInternalShellCount(regionIndex) . |
std::out_of_range | If faceIndex >= getFaceCountOfInternalShell(regionIndex,
internalShellIndex) . |
regionIndex | Zero-based index of the framework region. |
internalShellIndex | Zero-based index of the internal shell. |
faceIndex | Zero-based index of the face. |
faceIndex
of the internal shell internalShellIndex
of the region regionIndex
of this framework. Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
class StratigraphicUnitInterpretation * resqml2::SealedVolumeFrameworkRepresentation::getStratiUnitInterp | ( | uint64_t | regionIndex | ) | const |
Gets the stratigraphic unit interpretation a particular region of this framework represents.
std::out_of_range | If regionIndex >= getRegionCount(). |
regionIndex | Zero-based index of the region. |
regionIndex
.
|
inlinefinalvirtual |
Gets the standard XML tag without XML namespace for serializing this data object.
Reimplemented from resqml2::RepresentationSetRepresentation.
|
pure virtual |
Pushes back an internal shell in a particular volume region of this sealed volume framework.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::invalid_argument | If externalShellFaceCount == 0 . |
regionIndex | Zero-base index of the volume region where to push back the internal shell. |
internalShellFaceCount | The count of faces composing the region internal shell. |
faceRepresentationIndices | An array containing, for each internal shell face, the index of the corresponding representation in the representation list of this organization. The size of this array is internalShellFaceCount . |
faceRepPatchIndices | An array containing, for each internal shell face, the index of the corresponding patch in the corresponding representation. The size of this array is internalShellFaceCount . |
faceSide | An array containing the orientation of each internal shell face. The positive orientation is defined with true while the negative one is defined with false . The size of this array is internalShellFaceCount . |
Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
|
pure virtual |
Pushes back a volume region in this sealed volume framework.
std::invalid_argument | If stratiUnitInterp == nullptr . |
std::invalid_argument | If externalShellFaceCount == 0 . |
[in] | stratiUnitInterp | The stratigraphic unit interpretation represented by this region. |
externalShellFaceCount | The count of faces composing the region external shell. | |
faceRepresentationIndices | An array containing, for each external shell face, the index of the corresponding representation in the representation list of this organization. The size of this array is externalShellFaceCount . | |
faceRepPatchIndices | An array containing, for each external shell face, the index of the corresponding patch in the corresponding representation. The size of this array is externalShellFaceCount . | |
faceSide | An array containing the orientation of each external shell face. The positive orientation is defined with true while the negative one is defined with false . The size of this array is externalShellFaceCount . |
Implemented in resqml2_0_1::SealedVolumeFrameworkRepresentation, and resqml2_2::SealedVolumeFrameworkRepresentation.
void resqml2::SealedVolumeFrameworkRepresentation::setInterpretationOfVolumeRegion | ( | uint64_t | regionIndex, |
StratigraphicUnitInterpretation * | stratiUnitInterp ) |
Sets the stratigraphic unit interpretation of a particular volume region.
std::out_of_range | If regionIndex >= getRegionCount(). |
std::invalid_argument | If stratiUnitInterp == nullptr . |
regionIndex | Zero-base index of the volume region. | |
[in] | stratiUnitInterp | The stratigraphic unit interpretation represented by the region at position regionIndex . |
void resqml2::SealedVolumeFrameworkRepresentation::setSealedSurfaceFramework | ( | SealedSurfaceFrameworkRepresentation * | ssf | ) |
Sets the sealed surface framework representation this sealed volume framework representation is based on.
std::invalid_argument | If ssf == nullptr . |
[in] | ssf | The sealed surface framework representation to set. |
|
static |
The standard XML tag without XML namespace for serializing this data object.