resqml2_0_1::GridConnectionSetRepresentation Class Reference

Inheritance diagram for resqml2_0_1::GridConnectionSetRepresentation:

Public Member Functions
	GridConnectionSetRepresentation (gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
	GridConnectionSetRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title)
	GridConnectionSetRepresentation (soap *soapContext, const std::string &guid, const std::string &title)
	GridConnectionSetRepresentation (gsoap_resqml2_0_1::_resqml2__GridConnectionSetRepresentation *fromGsoap)
	~GridConnectionSetRepresentation ()
std::string	getHdfProxyUuid () const
ULONG64	getCellIndexPairCount () const
ULONG64	getCellIndexPairs (ULONG64 *cellIndexPairs) const
unsigned int	getCellIndexPairCountFromInterpretationIndex (const unsigned int &interpretationIndex) const
bool	isAssociatedToInterpretations () const
void	getInterpretationIndexCumulativeCount (unsigned int *cumulativeCount) const
void	getInterpretationIndices (unsigned int *interpretationIndices) const
LONG64	getInterpretationIndexNullValue () const
void	getGridConnectionSetInformationFromInterpretationIndex (ULONG64 *cellIndexPairs, ULONG64 *gridIndexPairs, int *localFaceIndexPairs, const unsigned int &interpretationIndex) const
std::string	getInterpretationUuidFromIndex (const unsigned int &interpretationIndex) const
unsigned int	getInterpretationCount () const
bool	hasLocalFacePerCell () const
void	getLocalFacePerCellIndexPairs (int *localFacePerCellIndexPairs) const
bool	isBasedOnMultiGrids () const
void	getGridIndexPairs (ULONG64 *gridIndexPairs) const
void	setCellIndexPairsUsingExistingDataset (const ULONG64 &cellIndexPairCount, const std::string &cellIndexPair, const ULONG64 &nullValue, resqml2::AbstractHdfProxy *proxy, const std::string &gridIndexPair="")
void	setLocalFacePerCellIndexPairsUsingExistingDataset (const std::string &localFacePerCellIndexPair, resqml2::AbstractHdfProxy *proxy)
void	setLocalFacePerCellIndexPairs (const ULONG64 &cellIndexPairCount, int *localFacePerCellIndexPair, resqml2::AbstractHdfProxy *proxy)
void	setConnectionInterpretationIndices (unsigned int *interpretationIndices, const unsigned int &interpretationIndiceCount, const ULONG64 &nullValue, resqml2::AbstractHdfProxy *proxy)
unsigned int	getSupportingGridRepresentationCount () const
std::string	getSupportingGridRepresentationUuid (unsigned int index) const
std::string	getSupportingGridRepresentationTitle (unsigned int index) const
std::string	getSupportingGridRepresentationContentType (unsigned int index) const
Public Member Functions inherited from resqml2::GridConnectionSetRepresentation
virtual std::string	getXmlTag () const
class AbstractFeatureInterpretation *	getInterpretationFromIndex (const unsigned int &interpretationIndex) const
void	setCellIndexPairs (const ULONG64 &cellIndexPairCount, ULONG64 *cellIndexPair, const ULONG64 &nullValue, resqml2::AbstractHdfProxy *proxy, ULONG64 *gridIndexPair=nullptr)
void	pushBackInterpretation (class AbstractFeatureInterpretation *interp)
void	pushBackSupportingGridRepresentation (class AbstractGridRepresentation *supportingGridRep)
class AbstractGridRepresentation *	getSupportingGridRepresentation (unsigned int index) const
ULONG64	getXyzPointCountOfPatch (const unsigned int &patchIndex) const
void	getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
unsigned int	getPatchCount () const
Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()
class AbstractLocal3dCrs *	getLocalCrs () const
virtual std::string	getLocalCrsUuid () const
class AbstractHdfProxy *	getHdfProxy () const
const std::vector< class AbstractProperty * > &	getPropertySet () const
std::vector< class AbstractValuesProperty * >	getValuesPropertySet () const
unsigned int	getValuesPropertyCount () const
class AbstractValuesProperty *	getValuesProperty (const unsigned int &index) const
void	setInterpretation (class AbstractFeatureInterpretation *interp)
class AbstractFeatureInterpretation *	getInterpretation () const
std::string	getInterpretationUuid () const
std::string	getInterpretationContentType () const
void	addSubRepresentation (SubRepresentation *subRep)
std::vector< SubRepresentation * >	getSubRepresentationSet () const
unsigned int	getSubRepresentationCount () const
SubRepresentation *	getSubRepresentation (const unsigned int &index) const
std::vector< SubRepresentation * >	getFaultSubRepresentationSet () const
unsigned int	getFaultSubRepresentationCount () const
SubRepresentation *	getFaultSubRepresentation (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
AbstractRepresentation *	getSeismicSupportOfPatch (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::EpcDocument *	getEpcDocument () 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

Protected Member Functions
void	init (soap *soapContext, const std::string &guid, const std::string &title)
void	pushBackXmlInterpretation (resqml2::AbstractFeatureInterpretation *interp)
void	pushBackXmlSupportingGridRepresentation (resqml2::AbstractGridRepresentation *supportingGridRep)
Protected Member Functions inherited from resqml2::GridConnectionSetRepresentation
	GridConnectionSetRepresentation (gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
	GridConnectionSetRepresentation (class AbstractFeatureInterpretation *interp)
	GridConnectionSetRepresentation (gsoap_resqml2_0_1::_resqml2__GridConnectionSetRepresentation *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)
virtual gsoap_resqml2_0_1::resqml2__PointGeometry *	getPointGeometry2_0_1 (const unsigned int &patchIndex) const
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 Public Attributes inherited from resqml2::GridConnectionSetRepresentation
static const char *	XML_TAG = "GridConnectionSetRepresentation"
Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char *	XML_TAG = "AbstractRepresentation"
Static Protected Member Functions inherited from resqml2::AbstractObject
static void	addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
Protected Attributes inherited from resqml2::AbstractRepresentation
class AbstractFeatureInterpretation *	interpretation
resqml2::AbstractHdfProxy *	hdfProxy
class AbstractLocal3dCrs *	localCrs
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::EpcDocument *	epcDocument
std::vector< resqml2::Activity * >	activitySet
bool	updateXml

Constructor & Destructor Documentation

resqml2_0_1::GridConnectionSetRepresentation::GridConnectionSetRepresentation ( gsoap_resqml2_0_1::eml__DataObjectReference *  partialObject )

inline

Only to be used in partial transfer context

resqml2_0_1::GridConnectionSetRepresentation::GridConnectionSetRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

interp	The interpretation the instance represents.
guid	A guid for the instance to create.
title	A title for the instance to create.

GridConnectionSetRepresentation::GridConnectionSetRepresentation	(	soap *	soapContext,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

interp	The interpretation the instance represents.
guid	A guid for the instance to create.
title	A title for the instance to create.

resqml2_0_1::GridConnectionSetRepresentation::GridConnectionSetRepresentation ( gsoap_resqml2_0_1::_resqml2__GridConnectionSetRepresentation *  fromGsoap )

inline

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

resqml2_0_1::GridConnectionSetRepresentation::~GridConnectionSetRepresentation ( )

inlinevirtual

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

Reimplemented from resqml2::GridConnectionSetRepresentation.

Member Function Documentation

ULONG64 GridConnectionSetRepresentation::getCellIndexPairCount ( ) const

virtual

Get the cell index pair count of this grid connection representation

Implements resqml2::GridConnectionSetRepresentation.

unsigned int GridConnectionSetRepresentation::getCellIndexPairCountFromInterpretationIndex ( const unsigned int &  interpretationIndex ) const

virtual

Get the cell index pairs count which correspond to a particular interpretation.

Parameters

interpretationIndex

The index of the interpretation in the collection of feature interpretation of this grid connection set.

Implements resqml2::GridConnectionSetRepresentation.

ULONG64 GridConnectionSetRepresentation::getCellIndexPairs ( ULONG64 *  cellIndexPairs ) const

virtual

Get the cell index pair count of this grid connection representation

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::getGridConnectionSetInformationFromInterpretationIndex ( ULONG64 *  cellIndexPairs, ULONG64 *  gridIndexPairs, int *  localFaceIndexPairs, const unsigned int &  interpretationIndex  ) const

virtual

Get the cell index pairs, the grid index pairs (optional) and the local face pairs (optional) which correspond to a particular interpretation.

Parameters

cellIndexPairs	Mandatory. Must be allocated with getCellIndexPairCountFromIndex first.
gridIndexPairs	Optional (put null if you don't want it). Must be allocated with getCellIndexPairCountFromIndex first.
localFaceIndexPairs	Optional (put null if you don't want it). Must be allocated with getCellIndexPairCountFromIndex first.
interpretationIndex	The index of the interpretation in the collection of feature interpretation of this grid connection set.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::getGridIndexPairs ( ULONG64 *  gridIndexPairs ) const

virtual

Get the grid index pairs of this grid connection representation The count of gridIndexPairs must be getCellIndexPairCount()*2.

Implements resqml2::GridConnectionSetRepresentation.

unsigned int GridConnectionSetRepresentation::getInterpretationCount ( ) const

virtual

Get the count of interpretations in this grid connection set.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::getInterpretationIndexCumulativeCount ( unsigned int *  cumulativeCount ) const

virtual

Get the interpretation index cumulative count of this grid connection representation The count of cumulativeCount must be getCellIndexPairCount().

Implements resqml2::GridConnectionSetRepresentation.

LONG64 GridConnectionSetRepresentation::getInterpretationIndexNullValue ( ) const

virtual

Returns the null value for interpretation index.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::getInterpretationIndices ( unsigned int *  interpretationIndices ) const

virtual

Get the interpretation indices of this grid connection representation The count of interpretationIndices is the last value of the array returning by getInterpretationIndexCumulativeCount.

Implements resqml2::GridConnectionSetRepresentation.

std::string GridConnectionSetRepresentation::getInterpretationUuidFromIndex ( const unsigned int &  interpretationIndex ) const

virtual

Get the UUID of a particular interpretation of this grid connection set.

Parameters

interpretationIndex

The index of the interpretation in the collection of feature interpretation of this grid connection set.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::getLocalFacePerCellIndexPairs ( int *  localFacePerCellIndexPairs ) const

virtual

Get the local face cell index pairs of this grid connection representation The count of localFacePerCellIndexPairs must be getCellIndexPairCount()*2.

Implements resqml2::GridConnectionSetRepresentation.

std::string GridConnectionSetRepresentation::getSupportingGridRepresentationContentType ( unsigned int  index ) const

virtual

Get the one of the supporting grid representation content type of this grid connection representation.

Implements resqml2::GridConnectionSetRepresentation.

unsigned int GridConnectionSetRepresentation::getSupportingGridRepresentationCount ( ) const

virtual

Get the count of the supporting grid representations of this grid connection representation.

Implements resqml2::GridConnectionSetRepresentation.

std::string GridConnectionSetRepresentation::getSupportingGridRepresentationTitle ( unsigned int  index ) const

virtual

Get the one of the supporting grid representation title of this grid connection representation.

Implements resqml2::GridConnectionSetRepresentation.

std::string GridConnectionSetRepresentation::getSupportingGridRepresentationUuid ( unsigned int  index ) const

virtual

Get the first supporting grid representation uuid of this grid connection representation.

Implements resqml2::GridConnectionSetRepresentation.

bool GridConnectionSetRepresentation::hasLocalFacePerCell ( ) const

virtual

Indicates if the grid connection set representation contains information on the connected faces of the two cells.

Implements resqml2::GridConnectionSetRepresentation.

bool GridConnectionSetRepresentation::isAssociatedToInterpretations ( ) const

virtual

Indicates wether the cell connection are associated to interpretation or not.

Implements resqml2::GridConnectionSetRepresentation.

bool GridConnectionSetRepresentation::isBasedOnMultiGrids ( ) const

virtual

Indicates if the grid connection set representation is based on several grids.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::pushBackXmlInterpretation ( resqml2::AbstractFeatureInterpretation *  interp )

protectedvirtual

Pushes back an interpretation which can be mapped with some connections.

Parameters

interp

The interpration to push back.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::pushBackXmlSupportingGridRepresentation ( resqml2::AbstractGridRepresentation *  supportingGridRep )

protectedvirtual

Pushes back a grid representation which is one of the support of this representation. And push back this representation as a grid connection information of the grid representation as well.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::setCellIndexPairsUsingExistingDataset ( const ULONG64 &  cellIndexPairCount, const std::string &  cellIndexPair, const ULONG64 &  nullValue, resqml2::AbstractHdfProxy *  proxy, const std::string &  gridIndexPair = ""  )

virtual

Set the cell index pairs of the grid connections representation using some exisiting hdf5 datasets.

Parameters

cellIndexPairCount	The count of cell index pair. It is half of all the stored numerical values.
cellIndexPair	The HDF dataset path where we can find all the cell index pair in a 1d Array where the cell indices go faster than the pair.
nullValue	The integer null value used in the hdf dataset for null cell and potentially null grid.
proxy	The HDF proxy where the numerical values (cell indices) are stored.
gridIndexPair	The HDF dataset path where we can find all the grid index pair in a 1d Array where the grid indices go faster than the pair. The grid at an index must correspond to the cell at the same index in the cellIndexPair array.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::setConnectionInterpretationIndices ( unsigned int *  interpretationIndices, const unsigned int &  interpretationIndiceCount, const ULONG64 &  nullValue, resqml2::AbstractHdfProxy *  proxy  )

virtual

For each connection in the grid connection set representation, allow to map zero or one feature interpretation. TODO: Resqml allows to map with more than one feature interpretation.

Parameters

interpretationIndices	For each connection, the index of the corresponding interpretation in the interpretation set of this grid connection. The count of this array is given by the next parameter.
interpretationIndiceCount	The count of interpretation indices.
nullValue	The null value must be used as the corresponding interpretation index for each connection which are not associated to any interpretation.
proxy	The Hdf proxy where the numerical values will be stored.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::setLocalFacePerCellIndexPairs ( const ULONG64 &  cellIndexPairCount, int *  localFacePerCellIndexPair, resqml2::AbstractHdfProxy *  proxy  )

virtual

2 x #Connections array of local face-per-cell indices for (Cell1,Cell2) for each connection. Local face-per-cell indices are used because global face indices need not have been defined. The numerical values wil: be written as a new hdf5 dataset in an existing hdf5 file. Null value = -1 by documentation.

Parameters

cellIndexPairCount	The count of cell index pair. It is half of all the stored numerical values.
localFacePerCellIndexPair	The HDF dataset path where we can find all the local Face Per CellIndex Pair in a 1d Array.
proxy	The HDF proxy where the numerical values (cell indices) are stored.

Implements resqml2::GridConnectionSetRepresentation.

void GridConnectionSetRepresentation::setLocalFacePerCellIndexPairsUsingExistingDataset	(	const std::string &	localFacePerCellIndexPair,
		resqml2::AbstractHdfProxy *	proxy
	)

The numerical values 2 x #Connections array of local face-per-cell indices for (Cell1,Cell2) for each connection. Local face-per-cell indices are used because global face indices need not have been defined. The numerical values are already stored in an existing hdf5 dataset. Null value = -1 by documentation.

Parameters

localFacePerCellIndexPair	The HDF dataset path where we can find all the local Face Per CellIndex Pair in a 1d Array.
proxy	The HDF proxy where the numerical values (cell indices) are stored.

---

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

• C:/Users/Philippe/dev/total/pluginTotal/version-0.9/src/resqml2_0_1/GridConnectionSetRepresentation.h
• C:/Users/Philippe/dev/total/pluginTotal/version-0.9/src/resqml2_0_1/GridConnectionSetRepresentation.cpp