My Project
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
resqml2::SubRepresentation Class Referenceabstract
Inheritance diagram for resqml2::SubRepresentation:
resqml2::AbstractRepresentation resqml2::AbstractObject resqml2_0_1::SubRepresentation

Public Member Functions

virtual ~SubRepresentation ()
 
virtual std::string getXmlTag () const
 
virtual indexableElement getElementKindOfPatch (const unsigned int &patchIndex, const unsigned int &elementIndicesIndex) const =0
 
virtual ULONG64 getElementCountOfPatch (const unsigned int &patchIndex) const =0
 
virtual void getElementIndicesOfPatch (const unsigned int &patchIndex, const unsigned int &elementIndicesIndex, ULONG64 *elementIndices) const =0
 
virtual bool areElementIndicesPairwise (const unsigned int &patchIndex) const =0
 
virtual bool areElementIndicesBasedOnLattice (const unsigned int &patchIndex, const unsigned int &elementIndicesIndex=0) const =0
 
virtual LONG64 getLatticeElementIndicesStartValue (const unsigned int &patchIndex, const unsigned int &elementIndicesIndex=0) const =0
 
virtual unsigned int getLatticeElementIndicesDimensionCount (const unsigned int &patchIndex, const unsigned int &elementIndicesIndex=0) const =0
 
virtual LONG64 getLatticeElementIndicesOffsetValue (const unsigned int &latticeDimensionIndex, const unsigned int &patchIndex, const unsigned int &elementIndicesIndex=0) const =0
 
virtual ULONG64 getLatticeElementIndicesOffsetCount (const unsigned int &latticeDimensionIndex, const unsigned int &patchIndex, const unsigned int &elementIndicesIndex=0) const =0
 
virtual void pushBackSubRepresentationPatch (const gsoap_resqml2_0_1::resqml2__IndexableElements &elementKind, const ULONG64 &originIndex, const unsigned int &elementCountInSlowestDimension, const unsigned int &elementCountInMiddleDimension, const unsigned int &elementCountInFastestDimension)=0
 
virtual void pushBackSubRepresentationPatch (const gsoap_resqml2_0_1::resqml2__IndexableElements &elementKind, const ULONG64 &elementCount, ULONG64 *elementIndices, resqml2::AbstractHdfProxy *proxy)=0
 
virtual void pushBackSubRepresentationPatch (const gsoap_resqml2_0_1::resqml2__IndexableElements &elementKind0, const gsoap_resqml2_0_1::resqml2__IndexableElements &elementKind1, const ULONG64 &elementCount, ULONG64 *elementIndices0, ULONG64 *elementIndices1, resqml2::AbstractHdfProxy *proxy)=0
 
virtual void pushBackRefToExistingDataset (const gsoap_resqml2_0_1::resqml2__IndexableElements &elementKind, const ULONG64 &elementCount, const std::string &dataset, const LONG64 &nullValue, resqml2::AbstractHdfProxy *proxy)=0
 
ULONG64 getXyzPointCountOfPatch (const unsigned int &patchIndex) const
 
void getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
 
virtual unsigned int getPatchCount () const =0
 
resqml2::AbstractRepresentationgetSupportingRepresentation () const
 
virtual std::string getSupportingRepresentationUuid () const =0
 
virtual std::string getSupportingRepresentationTitle () const =0
 
virtual std::string getSupportingRepresentationContentType () const =0
 
- Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()
 
class AbstractLocal3dCrsgetLocalCrs () const
 
virtual std::string getLocalCrsUuid () const
 
class AbstractHdfProxygetHdfProxy () const
 
virtual std::string getHdfProxyUuid () const =0
 
const std::vector< class AbstractProperty * > & getPropertySet () const
 
std::vector< class AbstractValuesProperty * > getValuesPropertySet () const
 
unsigned int getValuesPropertyCount () const
 
class AbstractValuesPropertygetValuesProperty (const unsigned int &index) const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () const
 
std::string getInterpretationUuid () const
 
std::string getInterpretationContentType () const
 
void addSubRepresentation (SubRepresentation *subRep)
 
std::vector< SubRepresentation * > getSubRepresentationSet () const
 
unsigned int getSubRepresentationCount () const
 
SubRepresentationgetSubRepresentation (const unsigned int &index) const
 
std::vector< SubRepresentation * > getFaultSubRepresentationSet () const
 
unsigned int getFaultSubRepresentationCount () const
 
SubRepresentationgetFaultSubRepresentation (const unsigned int &index) const
 
ULONG64 getXyzPointCountOfAllPatches () const
 
void getXyzPointsOfPatchInGlobalCrs (const unsigned int &patchIndex, double *xyzPoints) const
 
void getXyzPointsOfAllPatches (double *xyzPoints) const
 
void getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
 
AbstractRepresentationgetSeismicSupportOfPatch (const unsigned int &patchIndex)
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet, bool xml=true)
 
void setHdfProxy (resqml2::AbstractHdfProxy *proxy)
 
void addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, double *inlines, double *crosslines, const unsigned int &pointCount, resqml2::AbstractRepresentation *seismicSupport, resqml2::AbstractHdfProxy *proxy)
 
void addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, const double &startInline, const double &incrInline, const unsigned int &countInline, const double &startCrossline, const double &incrCrossline, const unsigned int &countCrossline, resqml2::AbstractRepresentation *seismicSupport)
 
void addSeismic2dCoordinatesToPatch (const unsigned int patchIndex, double *lineAbscissa, const unsigned int &pointCount, resqml2::AbstractRepresentation *seismicSupport, resqml2::AbstractHdfProxy *proxy)
 
void getSeismicLineAbscissaOfPointsOfPatch (const unsigned int &patchIndex, double *values)
 
- Public Member Functions inherited from resqml2::AbstractObject
bool isPartial () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml__DataObjectReference * newResqmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
common::EpcDocumentgetEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
std::string getContentType () const
 
std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< resqml2::Activity * > & getActivitySet () const
 
void addOrSetExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::string getExtraMetadata (const std::string &key)
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Static Public Attributes

static const char * XML_TAG = "SubRepresentation"
 
- Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char * XML_TAG = "AbstractRepresentation"
 

Protected Member Functions

 SubRepresentation (gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 
 SubRepresentation (resqml2::AbstractFeatureInterpretation *interp)
 
 SubRepresentation (gsoap_resqml2_0_1::_resqml2__SubRepresentation *fromGsoap)
 
- Protected Member Functions inherited from resqml2::AbstractRepresentation
 AbstractRepresentation (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 
 AbstractRepresentation (class AbstractFeatureInterpretation *interp, class AbstractLocal3dCrs *crs)
 
 AbstractRepresentation (gsoap_resqml2_0_1::resqml2__AbstractRepresentation *fromGsoap)
 
void pushBackSeismicSupport (AbstractRepresentation *seismicSupport)
 
void setXmlInterpretation (class AbstractFeatureInterpretation *interp)
 
gsoap_resqml2_0_1::resqml2__PointGeometry * createPointGeometryPatch2_0_1 (const unsigned int &patchIndex, double *points, unsigned long long *numPoints, const unsigned int &numDimensionsInArray, resqml2::AbstractHdfProxy *proxy)
 
std::string getHdfProxyUuidFromPointGeometryPatch (gsoap_resqml2_0_1::resqml2__PointGeometry *patch) const
 
gsoap_resqml2_0_1::resqml2__Seismic2dCoordinates * getSeismic2dCoordinates (const unsigned int &patchIndex) const
 
gsoap_resqml2_0_1::resqml2__Seismic3dCoordinates * getSeismic3dCoordinates (const unsigned int &patchIndex) const
 
- Protected Member Functions inherited from resqml2::AbstractObject
 AbstractObject (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API. More...
 
 AbstractObject (gsoap_resqml2_0_1::eml__AbstractCitedDataObject *proxy=nullptr)
 
void initMandatoryMetadata ()
 
void setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 

Additional Inherited Members

- Public Types inherited from resqml2::AbstractRepresentation
enum  indexableElement {
  NODE = 0, EDGE = 1, FACE = 2, VOLUME = 3,
  PILLAR = 4
}
 
- Static Protected Member Functions inherited from resqml2::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from resqml2::AbstractRepresentation
class AbstractFeatureInterpretationinterpretation
 
resqml2::AbstractHdfProxyhdfProxy
 
class AbstractLocal3dCrslocalCrs
 
std::vector< AbstractRepresentation * > seismicSupportSet
 
std::vector< SubRepresentation * > subRepresentationSet
 
std::vector< AbstractProperty * > propertySet
 
std::vector< AbstractRepresentation * > seismicSupportedRepSet
 
std::vector< class RepresentationSetRepresentation * > representationSetRepresentationSet
 
- Protected Attributes inherited from resqml2::AbstractObject
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * gsoapProxy2_0_1
 
common::EpcDocumentepcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

resqml2::SubRepresentation::SubRepresentation ( gsoap_resqml2_0_1::eml__DataObjectReference *  partialObject)
inlineprotected

Only to be used in partial transfer context

resqml2::SubRepresentation::SubRepresentation ( gsoap_resqml2_0_1::_resqml2__SubRepresentation *  fromGsoap)
inlineprotected

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

virtual resqml2::SubRepresentation::~SubRepresentation ( )
inlinevirtual

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

Reimplemented in resqml2_0_1::SubRepresentation.

Member Function Documentation

virtual bool resqml2::SubRepresentation::areElementIndicesBasedOnLattice ( const unsigned int &  patchIndex,
const unsigned int &  elementIndicesIndex = 0 
) const
pure virtual

Check if the element indices of a particular patch are based on a lattice or not.

Parameters
elementIndicesIndexIn case of pairwise element, allow to select the first or second element indice of the pair.

Implemented in resqml2_0_1::SubRepresentation.

virtual bool resqml2::SubRepresentation::areElementIndicesPairwise ( const unsigned int &  patchIndex) const
pure virtual

Check if the element of a particular patch are pairwise or not.

Implemented in resqml2_0_1::SubRepresentation.

virtual ULONG64 resqml2::SubRepresentation::getElementCountOfPatch ( const unsigned int &  patchIndex) const
pure virtual

Get the count of the selected elements for a particular patch of this subrepresentation.

Implemented in resqml2_0_1::SubRepresentation.

virtual void resqml2::SubRepresentation::getElementIndicesOfPatch ( const unsigned int &  patchIndex,
const unsigned int &  elementIndicesIndex,
ULONG64 *  elementIndices 
) const
pure virtual

Get the indices of the selected elements in the supporting representation for a particular patch of this subrepresentation.

Implemented in resqml2_0_1::SubRepresentation.

virtual indexableElement resqml2::SubRepresentation::getElementKindOfPatch ( const unsigned int &  patchIndex,
const unsigned int &  elementIndicesIndex 
) const
pure virtual

Get the kind of the selected elements for a particular patch of this subrepresentation.

Implemented in resqml2_0_1::SubRepresentation.

virtual std::string resqml2::SubRepresentation::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements resqml2::AbstractObject.

ULONG64 SubRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex) const
virtual

Get the xyz point count in a given patch.

Implements resqml2::AbstractRepresentation.

void SubRepresentation::getXyzPointsOfPatch ( const unsigned int &  patchIndex,
double *  xyzPoints 
) const
virtual

Get all the XYZ points of a particular patch of this representation. XYZ points are given in the local CRS.

Parameters
xyzPointsA linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be pre allocated.

Implements resqml2::AbstractRepresentation.

virtual void resqml2::SubRepresentation::pushBackRefToExistingDataset ( const gsoap_resqml2_0_1::resqml2__IndexableElements &  elementKind,
const ULONG64 &  elementCount,
const std::string &  dataset,
const LONG64 &  nullValue,
resqml2::AbstractHdfProxy proxy 
)
pure virtual

Push back a new patch (without pairwise elements) in the subrepresentation where the indice values have not to be written in the HDF file. The reason can be that the indice values already exist in an external file (only HDF5 for now) or that the writing of these indice values in the external file is defered in time.

Parameters
elementKindThe kind of (indexable) elements which constitutes the subrepresentation.
elementCountThe count of elements which constitutes the subrepresentation.
datasetIf empty, the dataset will be named the same as the dataset naming convention of the fesapi :"/RESQML/" + subRep->uuid + "/subrepresentation_elementIndices0_patch" + patchIndex;
nullValueThe null value which has been chosen in the referenced hdf dataset.
hdfProxyThe HDF5 proxy where the values are already or will be stored.

Implemented in resqml2_0_1::SubRepresentation.

virtual void resqml2::SubRepresentation::pushBackSubRepresentationPatch ( const gsoap_resqml2_0_1::resqml2__IndexableElements &  elementKind,
const ULONG64 &  originIndex,
const unsigned int &  elementCountInSlowestDimension,
const unsigned int &  elementCountInMiddleDimension,
const unsigned int &  elementCountInFastestDimension 
)
pure virtual

Push back a new patch in the subrepresentation which is based on a lattice definition.

Parameters
elementKindThe kind of (indexable) elements which constitutes the subrepresentation.
elementCountInSlowestDimensionCommonly in K dimensionn.
elementCountInMiddleDimensionCommonly in J dimensionn.
elementCountInFastestDimensionCommonly in I dimension.

Implemented in resqml2_0_1::SubRepresentation.

virtual void resqml2::SubRepresentation::pushBackSubRepresentationPatch ( const gsoap_resqml2_0_1::resqml2__IndexableElements &  elementKind,
const ULONG64 &  elementCount,
ULONG64 *  elementIndices,
resqml2::AbstractHdfProxy proxy 
)
pure virtual

Push back a new patch in the subrepresentation.

Parameters
elementKindThe kind of (indexable) elements which constitutes the subrepresentation.
elementCountThe count of elements which constitutes the subrepresentation.
elementIndicesThe indices of the elements of the instance in the supporting representation.
proxyThe HDF proxy where the numerical values (indices) are stored.

Implemented in resqml2_0_1::SubRepresentation.

virtual void resqml2::SubRepresentation::pushBackSubRepresentationPatch ( const gsoap_resqml2_0_1::resqml2__IndexableElements &  elementKind0,
const gsoap_resqml2_0_1::resqml2__IndexableElements &  elementKind1,
const ULONG64 &  elementCount,
ULONG64 *  elementIndices0,
ULONG64 *  elementIndices1,
resqml2::AbstractHdfProxy proxy 
)
pure virtual

Push back a new patch in the subrepresentation which is constituted by means of pairwise elements.

Parameters
elementKind0The kind of (indexable) elements which constitutes the first part of the pair of elements of the subrepresentation.
elementKind1The kind of (indexable) elements which constitutes the second part of the pair of elements of the subrepresentation.
elementCountThe count of elements which constitutes the subrepresentation.
elementIndices0The indices of the first part of the element pair in the supporting representation.
elementIndices1The indices of the second part of the element pair in the supporting representation.
proxyThe HDF proxy where the numerical values (indices) are stored.

Implemented in resqml2_0_1::SubRepresentation.


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