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::IjkGridParametricRepresentation Class Referencefinal

#include <IjkGridParametricRepresentation.h>

Inheritance diagram for resqml2_0_1::IjkGridParametricRepresentation:
resqml2::IjkGridParametricRepresentation resqml2::AbstractIjkGridRepresentation resqml2::AbstractColumnLayerGridRepresentation resqml2::AbstractGridRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 IjkGridParametricRepresentation (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)
 
 IjkGridParametricRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)
 
 IjkGridParametricRepresentation (gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation *fromGsoap)
 Creates an instance of this class by wrapping a gSOAP instance. More...
 
 IjkGridParametricRepresentation (gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation *fromGsoap)
 Creates an instance of this class by wrapping a gSOAP instance. More...
 
 ~IjkGridParametricRepresentation ()=default
 
common::DataObjectReference getHdfProxyDor () const final
 Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry). More...
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS. More...
 
unsigned int getControlPointMaxCountPerPillar () const final
 
bool hasControlPointParameters () const final
 
bool isParametricLineKindConstant () const final
 
short getConstantParametricLineKind () const final
 
void setGeometryAsParametricSplittedPillarNodes (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, bool isRightHanded, double const *parameters, double const *controlPoints, double const *controlPointParameters, unsigned int controlPointMaxCountPerPillar, short const *pillarKind, eml2::AbstractHdfProxy *proxy, unsigned long splitCoordinateLineCount, unsigned int const *pillarOfCoordinateLine, unsigned int const *splitCoordinateLineColumnCumulativeCount, unsigned int const *splitCoordinateLineColumns, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &parameters, const std::string &controlPoints, const std::string &controlPointParameters, unsigned int controlPointMaxCountPerPillar, const std::string &pillarKind, const std::string &definedPillars, eml2::AbstractHdfProxy *proxy, unsigned long splitCoordinateLineCount, const std::string &pillarOfCoordinateLine, const std::string &splitCoordinateLineColumnCumulativeCount, const std::string &splitCoordinateLineColumns, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &parameters, const std::string &controlPoints, const std::string &controlPointParameters, unsigned int controlPointCountPerPillar, short pillarKind, eml2::AbstractHdfProxy *proxy, unsigned long splitCoordinateLineCount, const std::string &pillarOfCoordinateLine, const std::string &splitCoordinateLineColumnCumulativeCount, const std::string &splitCoordinateLineColumns, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::IjkGridParametricRepresentation
void getXyzPointsOfKInterfaceSequence (unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double *xyzPoints) final
 Gets all the XYZ points of a particular sequence of K interfaces. XYZ points are given in the local CRS. More...
 
void getXyzPointsOfBlock (double *xyzPoints) final
 Gets all the XYZ points of the current block. XYZ points are given in the local CRS. Block information must be loaded. More...
 
void getControlPoints (double *controlPoints, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const
 
void getControlPointParameters (double *controlPointParameters, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const
 
void getParametricLineKind (short *pillarKind, bool reverseIAxis=false, bool reverseJAxis=false) const
 
void getParametersOfNodes (double *parameters, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const
 
void getParametersOfNodesOfKInterfaceSequence (unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double *parameters)
 
void setGeometryAsParametricNonSplittedPillarNodes (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, bool isRightHanded, double const *parameters, double const *controlPoints, double const *controlPointParameters, unsigned int controlPointMaxCountPerPillar, short const *pillarKind, eml2::AbstractHdfProxy *proxy=nullptr, resqml2::AbstractLocal3dCrs *localCrs=nullptr)
 
void setGeometryAsParametricNonSplittedPillarNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &parameters, const std::string &controlPoints, const std::string &controlPointParameters, unsigned int controlPointMaxCountPerPillar, const std::string &pillarKind, const std::string &definedPillars, eml2::AbstractHdfProxy *proxy=nullptr, resqml2::AbstractLocal3dCrs *localCrs=nullptr)
 
void setGeometryAsParametricSplittedPillarNodes (bool isRightHanded, double const *parameters, double const *controlPoints, double const *controlPointParameters, unsigned int controlPointCountPerPillar, short pillarKind, eml2::AbstractHdfProxy *proxy, unsigned long splitCoordinateLineCount, unsigned int const *pillarOfCoordinateLine, unsigned int const *splitCoordinateLineColumnCumulativeCount, unsigned int const *splitCoordinateLineColumns, resqml2::AbstractLocal3dCrs *localCrs=nullptr)
 
bool isNodeGeometryCompressed () const final
 
geometryKind getGeometryKind () const final
 
- Public Member Functions inherited from resqml2::AbstractIjkGridRepresentation
 AbstractIjkGridRepresentation (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)
 
 AbstractIjkGridRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)
 
 AbstractIjkGridRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject, bool withTruncatedPillars=false)
 
virtual ~AbstractIjkGridRepresentation ()
 
unsigned int getICellCount () const
 
void setICellCount (unsigned int iCount)
 
unsigned int getJCellCount () const
 
void setJCellCount (unsigned int jCount)
 Sets the count of cells in the J direction. More...
 
uint64_t getCellCount () const final
 
unsigned int getColumnCount () const
 
unsigned int getPillarCount () const
 
unsigned int getKGapsCount () const
 
void getKGaps (bool *kGaps) const
 
unsigned int getFaceCount () const
 
unsigned int getIPillarFromGlobalIndex (unsigned int globalIndex) const
 
unsigned int getJPillarFromGlobalIndex (unsigned int globalIndex) const
 
unsigned int getGlobalIndexPillarFromIjIndex (unsigned int iPillar, unsigned int jPillar) const
 
unsigned int getIColumnFromGlobalIndex (unsigned int globalIndex) const
 
unsigned int getJColumnFromGlobalIndex (unsigned int globalIndex) const
 
unsigned int getGlobalIndexColumnFromIjIndex (unsigned int iColumn, unsigned int jColumn) const
 
unsigned int getGlobalIndexCellFromIjkIndex (unsigned int iCell, unsigned int jCell, unsigned int kCell) const
 
bool isRightHanded () const
 
void getPillarsOfSplitCoordinateLines (unsigned int *pillarIndices, bool reverseIAxis=false, bool reverseJAxis=false) const
 
void getColumnsOfSplitCoordinateLines (unsigned int *columnIndices, bool reverseIAxis=false, bool reverseJAxis=false) const
 
void getColumnCountOfSplitCoordinateLines (unsigned int *columnIndexCountPerSplitCoordinateLine) const
 
unsigned long getSplitCoordinateLineCount () const
 
unsigned long getBlockSplitCoordinateLineCount () const
 
uint64_t getSplitNodeCount () const
 
void getPillarGeometryIsDefined (bool *pillarGeometryIsDefined, bool reverseIAxis=false, bool reverseJAxis=false) const
 
bool hasEnabledCellInformation () const
 
void getEnabledCells (bool *enabledCells, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const
 
void setEnabledCells (unsigned char *enabledCells, eml2::AbstractHdfProxy *proxy=nullptr)
 
void loadSplitInformation ()
 
void loadBlockInformation (unsigned int iInterfaceStart, unsigned int iInterfaceEnd, unsigned int jInterfaceStart, unsigned int jInterfaceEnd, unsigned int kInterfaceStart, unsigned int kInterfaceEnd)
 
void unloadSplitInformation ()
 
bool isColumnEdgeSplitted (unsigned int iColumn, unsigned int jColumn, unsigned int edge) const
 Checks either a given column edge is splitted or not. This method requires that you have already loaded the split information. More...
 
uint64_t getXyzPointIndexFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner) const
 Gets the XYZ point index in the HDF dataset from the corner of a cell. This method requires that you have already loaded the split information. More...
 
void getXyzPointOfBlockFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner, const double *xyzPoints, double &x, double &y, double &z) const
 Gets the x, y and z values of the corner of a cell of a given block. This method requires that you have already both loaded the block information and get the geometry of the block thanks to getXyzPointsOfBlock(). More...
 
uint64_t getXyzPointCountOfKInterface () const
 
uint64_t getXyzPointCountOfBlock () const
 
void getXyzPointsOfKInterface (unsigned int kInterface, double *xyzPoints)
 
gsoap_resqml2_0_1::resqml20__KDirection getKDirection () const override
 
virtual uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const override
 
std::string getXmlTag () const final
 
unsigned int getPatchCount () const override
 
- Public Member Functions inherited from resqml2::AbstractColumnLayerGridRepresentation
virtual ~AbstractColumnLayerGridRepresentation ()=default
 
unsigned int getKCellCount () const
 
void setKCellCount (unsigned int kCount)
 
void setIntervalAssociationWithStratigraphicOrganizationInterpretation (uint64_t *stratiUnitIndices, uint64_t nullValue, resqml2::AbstractStratigraphicOrganizationInterpretation *stratiOrgInterp, eml2::AbstractHdfProxy *hdfProxy=nullptr)
 
common::DataObjectReference getStratigraphicOrganizationInterpretationDor () const final
 
bool hasIntervalStratigraphicUnitIndices () const
 
uint64_t getIntervalStratigraphicUnitIndices (uint64_t *stratiUnitIndices)
 
gsoap_resqml2_0_1::resqml20__PillarShape getMostComplexPillarGeometry () const
 
- Public Member Functions inherited from resqml2::AbstractGridRepresentation
virtual ~AbstractGridRepresentation ()=default
 
std::vector< class GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet () const
 
unsigned int getGridConnectionSetRepresentationCount () const
 
class GridConnectionSetRepresentationgetGridConnectionSetRepresentation (unsigned int index) const
 
AbstractGridRepresentationgetParentGrid () const
 
common::DataObjectReference getParentGridDor () const
 
std::vector< resqml2::AbstractGridRepresentation * > getChildGridSet () const
 
unsigned int getChildGridCount () const
 
AbstractGridRepresentationgetChildGrid (unsigned int index) const
 
void setParentWindow (uint64_t *cellIndices, uint64_t cellIndexCount, class UnstructuredGridRepresentation *parentGrid, eml2::AbstractHdfProxy *proxy=nullptr)
 
void setParentWindow (unsigned int *columnIndices, unsigned int columnIndexCount, unsigned int kLayerIndexRegridStart, unsigned int *childCellCountPerInterval, unsigned int *parentCellCountPerInterval, unsigned int intervalCount, class AbstractColumnLayerGridRepresentation *parentGrid, eml2::AbstractHdfProxy *proxy=nullptr, double *childCellWeights=nullptr)
 
void setParentWindow (unsigned int iCellIndexRegridStart, unsigned int *childCellCountPerIInterval, unsigned int *parentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int *childCellCountPerJInterval, unsigned int *parentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int *childCellCountPerKInterval, unsigned int *parentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation *parentGrid, eml2::AbstractHdfProxy *proxy=nullptr, double *iChildCellWeights=nullptr, double *jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)
 
void setParentWindow (unsigned int iCellIndexRegridStart, unsigned int constantChildCellCountPerIInterval, unsigned int constantParentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int constantChildCellCountPerJInterval, unsigned int constantParentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int constantChildCellCountPerKInterval, unsigned int constantParentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation *parentGrid, eml2::AbstractHdfProxy *proxy=nullptr, double *iChildCellWeights=nullptr, double *jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)
 Indicates that this grid takes place into another IJK parent grid. This method assumes that the count of cells per regrid interval is constant in both child and parent grids. More...
 
void setParentWindow (unsigned int iCellIndexRegridStart, unsigned int iChildCellCount, unsigned int iParentCellCount, unsigned int jCellIndexRegridStart, unsigned int jChildCellCount, unsigned int jParentCellCount, unsigned int kCellIndexRegridStart, unsigned int kChildCellCount, unsigned int kParentCellCount, class AbstractIjkGridRepresentation *parentGrid, eml2::AbstractHdfProxy *proxy=nullptr, double *iChildCellWeights=nullptr, double *jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)
 
void setForcedNonRegridedParentCell (uint64_t *cellIndices, uint64_t cellIndexCount)
 
void setCellOverlap (uint64_t parentChildCellPairCount, uint64_t *parentChildCellPair, const std::string &volumeUom, double *overlapVolumes=nullptr)
 
int64_t getParentCellIndexCount () const
 
void getParentCellIndices (uint64_t *parentCellIndices) const
 
int64_t getParentColumnIndexCount () const
 
void getParentColumnIndices (uint64_t *parentColumnIndices) const
 
uint64_t getRegridStartIndexOnParentGrid (char dimension) const
 
uint64_t getRegridIntervalCount (char dimension) const
 
bool isRegridCellCountPerIntervalConstant (char dimension, bool childVsParentCellCount) const
 
uint64_t getRegridConstantCellCountPerInterval (char dimension, bool childVsParentCellCount) const
 
void getRegridCellCountPerInterval (char dimension, uint64_t *childCellCountPerInterval, bool childVsParentCellCount) const
 
bool hasRegridChildCellWeights (char dimension) const
 
void getRegridChildCellWeights (char dimension, double *childCellWeights) const
 
bool hasForcedNonRegridedParentCell () const
 
void setCellAssociationWithStratigraphicOrganizationInterpretation (uint64_t *stratiUnitIndices, uint64_t nullValue, class AbstractStratigraphicOrganizationInterpretation *stratiOrgInterp)
 
class AbstractStratigraphicOrganizationInterpretationgetStratigraphicOrganizationInterpretation () const
 
bool hasCellStratigraphicUnitIndices () const
 
uint64_t getCellStratigraphicUnitIndices (uint64_t *stratiUnitIndices)
 
void setCellAssociationWithRockFluidOrganizationInterpretation (uint64_t *rockFluidUnitIndices, uint64_t nullValue, class RockFluidOrganizationInterpretation *rockFluidOrgInterp)
 
class RockFluidOrganizationInterpretationgetRockFluidOrganizationInterpretation () const
 
virtual common::DataObjectReference getRockFluidOrganizationInterpretationDor () const
 
bool hasCellFluidPhaseUnitIndices () const
 
uint64_t getCellFluidPhaseUnitIndices (uint64_t *rockfluidUnitIndices)
 
bool isTruncated () const
 
uint64_t getTruncatedFaceCount () const
 
void getNodeIndicesOfTruncatedFaces (uint64_t *nodeIndices) const
 
void getCumulativeNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const
 
void getNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const
 
uint64_t getTruncatedCellCount () const
 
void getTruncatedCellIndices (uint64_t *cellIndices) const
 
void getTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const
 
void getCumulativeTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const
 
void getTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const
 
void getNonTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const
 
void getCumulativeNonTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const
 
void getNonTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const
 
void getTruncatedFaceIsRightHanded (unsigned char *cellFaceIsRightHanded) const
 
void loadTargetRelationships ()
 
- 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::AbstractIjkGridRepresentation
static const char * XML_TAG
 
static const char * XML_TAG_TRUNCATED
 
- Static Public Attributes inherited from resqml2::AbstractGridRepresentation
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::AbstractIjkGridRepresentation
enum  geometryKind {
  UNKNOWN = 0 , EXPLICIT = 1 , PARAMETRIC = 2 , LATTICE = 3 ,
  NO_GEOMETRY = 4
}
 
- 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

An IJK Grid parametric representation define the cell corner positions by means of parameters along the pillars of the grid. Adjacent cell corner are supposed to be located the same so they are not repeated unless you define split lines or split nodes.

Constructor & Destructor Documentation

◆ IjkGridParametricRepresentation() [1/4]

resqml2_0_1::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( common::DataObjectRepository repo,
const std::string &  guid,
const std::string &  title,
unsigned int  iCount,
unsigned int  jCount,
unsigned int  kCount,
bool *  kGaps = nullptr,
eml2::AbstractHdfProxy proxy = nullptr 
)
inline

Constructor

Parameters
[in,out]repoIf non-null, the repo.
guidUnique identifier.
titleThe title.
iCountNumber of cell in I direction.
jCountNumber of cell in J direction.
kCountNumber of cell in K direction.
kGaps(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.
[in]proxy(Optional) The HDF proxy for writing the enabledCells values. If nullptr (default), then the default HDF proxy will be used.

◆ IjkGridParametricRepresentation() [2/4]

resqml2_0_1::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( resqml2::AbstractFeatureInterpretation interp,
const std::string &  guid,
const std::string &  title,
unsigned int  iCount,
unsigned int  jCount,
unsigned int  kCount,
bool *  kGaps = nullptr,
eml2::AbstractHdfProxy proxy = nullptr 
)
inline

Constructor

Parameters
[in,out]interpIf non-null, the interp.
guidUnique identifier.
titleThe title.
iCountNumber of cell in I direction.
jCountNumber of cell in J direction.
kCountNumber of cell in K direction.
kGaps(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.

◆ IjkGridParametricRepresentation() [3/4]

resqml2_0_1::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation *  fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ IjkGridParametricRepresentation() [4/4]

resqml2_0_1::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation *  fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~IjkGridParametricRepresentation()

resqml2_0_1::IjkGridParametricRepresentation::~IjkGridParametricRepresentation ( )
virtualdefault

Destructor clean pillarInformation memory when allocated

Reimplemented from resqml2::IjkGridParametricRepresentation.

Member Function Documentation

◆ getConstantParametricLineKind()

short resqml2_0_1::IjkGridParametricRepresentation::getConstantParametricLineKind ( ) const
finalvirtual

Gets the constant parametric line kind of this IJK parametric grid.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::logic_errorIf this grid is not actually a parametric one or if the getting of the constant parametric line kind is not supported yet for this grid.
Returns
The constant parametric line kind.

Implements resqml2::IjkGridParametricRepresentation.

◆ getControlPointMaxCountPerPillar()

unsigned int resqml2_0_1::IjkGridParametricRepresentation::getControlPointMaxCountPerPillar ( ) const
finalvirtual

Gets the maximum control points count on a pillar of this grid.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::range_errorIf the knot count of this grid is strictly greater than unsigned int max.
std::logic_errorIf the computing of the maximum control points count is not yet supported for this grid.
Returns
The maximum control points count on a pillar of this grid.

Implements resqml2::IjkGridParametricRepresentation.

◆ getHdfProxyDor()

common::DataObjectReference resqml2_0_1::IjkGridParametricRepresentation::getHdfProxyDor ( ) const
finalvirtual

Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

Exceptions
std::logic_errorIf this representation is partial.
Returns
The data object reference of the HDF proxy used for storing the geometry, or empty data object reference if it fails.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getXyzPointsOfPatch()

void resqml2_0_1::IjkGridParametricRepresentation::getXyzPointsOfPatch ( unsigned int  patchIndex,
double *  xyzPoints 
) const
finalvirtual

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions
std::logic_errorIf the geometry of the grid either does not exist or if it is not handled yet by fesapi.
std::logic_errorIf this grid is truncated and the additional grid points cannot be read.
std::out_of_rangeIf patchIndex >= getPatchCount().
Parameters
patchIndexThe index of the patch.
xyzPointsxyz double triplets ordered by i then j then split then k. It must be preallocated with a count of ((iCellCount+1) * (jCellCount+1) + splitCoordinateLineCount) * kCellCount.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ hasControlPointParameters()

bool resqml2_0_1::IjkGridParametricRepresentation::hasControlPointParameters ( ) const
finalvirtual

Checks if this IJK parametric grid contains some parameters on some control points. It happens when the grid contains at least one non vertical or a non Z linear parametric line.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::logic_errorIf the checking for the existance of control point parameters is not yet supported for this grid.
Returns
True if there exists some control point parameters, false if not.

Implements resqml2::IjkGridParametricRepresentation.

◆ isParametricLineKindConstant()

bool resqml2_0_1::IjkGridParametricRepresentation::isParametricLineKindConstant ( ) const
finalvirtual

Checks if the parametric lines kind is constant in this IJK parametric grid.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::logic_errorIf this grid is not actually a parametric one or if the checking for the parametric lines kind constantness is not supported yet for this grid.
Returns
True if the parametric lines kind is constant, false if not.

Implements resqml2::IjkGridParametricRepresentation.

◆ setGeometryAsParametricSplittedPillarNodes()

void resqml2_0_1::IjkGridParametricRepresentation::setGeometryAsParametricSplittedPillarNodes ( gsoap_resqml2_0_1::resqml20__PillarShape  mostComplexPillarGeometry,
bool  isRightHanded,
double const *  parameters,
double const *  controlPoints,
double const *  controlPointParameters,
unsigned int  controlPointMaxCountPerPillar,
short const *  pillarKind,
eml2::AbstractHdfProxy proxy,
unsigned long  splitCoordinateLineCount,
unsigned int const *  pillarOfCoordinateLine,
unsigned int const *  splitCoordinateLineColumnCumulativeCount,
unsigned int const *  splitCoordinateLineColumns,
resqml2::AbstractLocal3dCrs localCrs = nullptr 
)
finalvirtual

Sets the geometry of this IJK grid as parametric pillar nodes where at least one pillar is supposed to be splitted. Defined pillars are deduced from pillarKind == -1.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::invalid_argumentIf some parameters values are inconsistent.
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.
Parameters
mostComplexPillarGeometryThe most complex pillar shape which we can find on this ijk grid.
isRightHandedIndicates that the IJK grid is right handed, as determined by the triple product of tangent vectors in the I, J, and K directions.
[in]parametersThe parameter values (regarding the pillars) of each node of the grid.
[in]controlPointsThe control points of the pillars of the grid. They are ordered first (quickest) by pillar and then (slowest) by control point : cp0 of pillar0, cp0 of pillar1, cp0 of pillar3, ..., cp0 of pillarCount-1, cp1 of pillar0, cp1 of pillar1, etc... Pad with nan values if necessary.
[in]controlPointParametersThe value of the parameter at each control points. It must be nullptr for vertical and Z linear cubic parametric lines grid.
controlPointMaxCountPerPillarThe maximum count of control points which defines a pillar of this grid.
[in]pillarKindThe kind of each pillar : 0 = vertical, 1 = linear spline, 2 = natural cubic spline, 3 = cubic spline, 4 = Z linear cubic spline, 5 = minimum-curvature spline, (-1) = null: no line.
[in,out]proxyThe HDF proxy where all numerical values will be stored. If nullptr, then the default HDF proxy of the repository will be used.
splitCoordinateLineCountThe count of split coordinate line in this grid. A pillar being splitted by a maximum of 3 split coordinate lines (one coordinate line is always non splitted)
[in]pillarOfCoordinateLineFor each split coordinate line, indicates the pillar it belongs to.
[in]splitCoordinateLineColumnCumulativeCountFor each split coordinate line, indicates the count of grid column which are splitted by this coordinate line.
[in]splitCoordinateLineColumnsFor each split coordinate line, indicates the grid columns which are splitted by this coordinate line.
[in]localCrs(Optional) The local CRS where the points are given. If nullptr (default) then the default CRS of the repository will be used.

Implements resqml2::IjkGridParametricRepresentation.

◆ setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets() [1/2]

void resqml2_0_1::IjkGridParametricRepresentation::setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets ( gsoap_resqml2_0_1::resqml20__KDirection  kDirectionKind,
bool  isRightHanded,
const std::string &  parameters,
const std::string &  controlPoints,
const std::string &  controlPointParameters,
unsigned int  controlPointCountPerPillar,
short  pillarKind,
eml2::AbstractHdfProxy proxy,
unsigned long  splitCoordinateLineCount,
const std::string &  pillarOfCoordinateLine,
const std::string &  splitCoordinateLineColumnCumulativeCount,
const std::string &  splitCoordinateLineColumns,
resqml2::AbstractLocal3dCrs localCrs = nullptr 
)
finalvirtual

Set the geometry of the IJK grid as parametric pillar nodes where at least one pillar is supposed to be splitted and where all pillars are of the same kind. All pillars are assumed to be defined using this method.Same as setGeometryAsParametricSplittedPillarNodes where the HDF datasets are already written in the the file.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::invalid_argumentIf some parameters values are inconsistent.
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.
Parameters
kDirectionKindThe K direction kind.
isRightHandedIndicates that the IJK grid is right handed, as determined by the triple product of tangent vectors in the I, J, and K directions.
parametersPath to the HDF dataset containing the parameter values (regarding the pillars) of each node of the grid.
controlPointsPath to the HDF dataset containing the the control points of the pillars of the grid.
controlPointParametersPath to the HDF dataset containing the value of the parameter at each control points.
controlPointCountPerPillarThe maximum count of control points which defines a pillar of this grid.
pillarKindThe constant kind of each pillar : 0 = vertical, 1 = linear spline, 2 = natural cubic spline, 3 = cubic spline, 4 = Z linear cubic spline, 5 = minimum-curvature spline, (-1) = null: no line.
[in,out]proxyThe HDF proxy where all numerical values will be stored. If nullptr, then the default HDF proxy of the repository will be used.
splitCoordinateLineCountThe count of split coordinate line in this grid. A pillar being splitted by a maximum of 3 split coordinate lines (one coordinate line is always non splitted)
pillarOfCoordinateLinePath to the HDF dataset indicating for each split coordinate line, which pillar it belongs to.
splitCoordinateLineColumnCumulativeCountPath to the HDF dataset indicating for each split coordinate line, the count of grid column which are splitted by this coordinate line.
splitCoordinateLineColumnsPath to the HDF dataset indicating for each split coordinate line, the grid columns which are splitted by this coordinate line.
[in]localCrs(Optional) The local CRS where the points are given. If nullptr (default) then the default CRS of the repository will be used.

Implements resqml2::IjkGridParametricRepresentation.

◆ setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets() [2/2]

void resqml2_0_1::IjkGridParametricRepresentation::setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets ( gsoap_resqml2_0_1::resqml20__PillarShape  mostComplexPillarGeometry,
gsoap_resqml2_0_1::resqml20__KDirection  kDirectionKind,
bool  isRightHanded,
const std::string &  parameters,
const std::string &  controlPoints,
const std::string &  controlPointParameters,
unsigned int  controlPointMaxCountPerPillar,
const std::string &  pillarKind,
const std::string &  definedPillars,
eml2::AbstractHdfProxy proxy,
unsigned long  splitCoordinateLineCount,
const std::string &  pillarOfCoordinateLine,
const std::string &  splitCoordinateLineColumnCumulativeCount,
const std::string &  splitCoordinateLineColumns,
resqml2::AbstractLocal3dCrs localCrs = nullptr 
)
finalvirtual

Sets the geometry of this IJK grid as parametric pillar nodes where at least one pillar is supposed to be splitted. Defined pillars are deduced from pillarKind == -1. Same as setGeometryAsParametricSplittedPillarNodes() where the HDF datasets are already written in the the file.

Exceptions
std::invalid_argumentIf there is no geometry on this grid.
std::invalid_argumentIf some parameters values are inconsistent.
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.
Parameters
mostComplexPillarGeometryThe most complex pillar shape which we can find on this ijk grid.
kDirectionKindThe direction kind.
isRightHandedIndicates that the IJK grid is right handed, as determined by the triple product of tangent vectors in the I, J, and K directions.
parametersPath to the HDF dataset containing the parameter values (regarding the pillars) of each node of the grid.
controlPointsPath to the HDF dataset containing the the control points of the pillars of the grid.
controlPointParametersPath to the HDF dataset containing the value of the parameter at each control points.
controlPointMaxCountPerPillarThe maximum count of control points which defines a pillar of this grid.
pillarKindPath to the HDF dataset containing the kind of each pillar.
definedPillarsPath to the HDF dataset where the defined pillars are identified : 0 value for not defined (i.e control points are NaN points, i.e pillarKind == -1) else the pillar is defined. This information overrides any pillar geometry information.
[in,out]proxyThe HDF proxy where all numerical values will be stored. If nullptr, then the default HDF proxy of the repository will be used.
splitCoordinateLineCountThe count of split coordinate line in this grid. A pillar being splitted by a maximum of 3 split coordinate lines (one coordinate line is always non splitted)
pillarOfCoordinateLinePath to the HDF dataset indicating for each split coordinate line, which pillar it belongs to.
splitCoordinateLineColumnCumulativeCountPath to the HDF dataset indicating for each split coordinate line, the count of grid column which are splitted by this coordinate line.
splitCoordinateLineColumnsPath to the HDF dataset indicating for each split coordinate line, the grid columns which are splitted by this coordinate line.
[in]localCrs(Optional) The local CRS where the points are given. If nullptr (default) then the default CRS of the repository will be used.

Implements resqml2::IjkGridParametricRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::IjkGridParametricRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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