Proxy class for a representation set representation. This is the parent class of the framework representations. It is used to group together individual representations to represent a "bag" of representations. More...

#include <RepresentationSetRepresentation.h>

Inheritance diagram for resqml2::RepresentationSetRepresentation:

Public Member Functions
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)

virtual std::string	getXmlTag () const override

virtual void	loadTargetRelationships () override

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::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)

Detailed Description

Proxy class for a representation set representation. This is the parent class of the framework representations. It is used to group together individual representations to represent a "bag" of representations.

If the individual representations are all of the same type, then you can indicate that the set is homogenous. These "bags" do not imply any geologic consistency. For example, you can define a set of wellbore frames, a set of wellbore trajectories, a set of blocked wellbores. Because the framework representations inherit from this class, they inherit the capability to gather individual representations into sealed and non-sealed surface framework representations, or sealed volume framework representations.

Constructor & Destructor Documentation

◆ ~RepresentationSetRepresentation()

virtual resqml2::RepresentationSetRepresentation::~RepresentationSetRepresentation ( )

virtualdefault

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

Reimplemented in resqml2_0_1::RepresentationSetRepresentation, and resqml2_2::RepresentationSetRepresentation.

Member Function Documentation

◆ getHdfProxyDor()

common::DataObjectReference resqml2::RepresentationSetRepresentation::getHdfProxyDor ( ) const

inlinefinalvirtual

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

Returns: Empty data object reference since no geometry is directly associated to a representation set representation.

Implements resqml2::AbstractRepresentation.

◆ getPatchCount()

uint64_t resqml2::RepresentationSetRepresentation::getPatchCount ( ) const

inlineoverridevirtual

Gets the patch count.

Returns: 1 since we consider that representation set representations have only 1 patch.

Implements resqml2::AbstractRepresentation.

◆ getRepresentation()

resqml2::AbstractRepresentation * resqml2::RepresentationSetRepresentation::getRepresentation ( uint64_t index ) const

Gets a particular representation in this representation set according to its position.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `index` is out of range.

Parameters

index Zero-based index of the of the representation we look for.

Returns: A pointer to the representation at position index.

◆ getRepresentationCount()

uint64_t resqml2::RepresentationSetRepresentation::getRepresentationCount ( ) const

Gets the count of representations in this representation set.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::range_error	If the count is strictly greater than unsigned int max.

Returns: The representation count.

◆ getRepresentationDor()

common::DataObjectReference resqml2::RepresentationSetRepresentation::getRepresentationDor ( uint64_t index ) const

Gets the data object reference of a particular representation in this representation set according to its position.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `index` is out of range.

Parameters

index Zero-based index of the of the representation we look for.

Returns: The data object reference of the representation at position index.

◆ getXmlTag()

virtual std::string resqml2::RepresentationSetRepresentation::getXmlTag ( ) const

inlineoverridevirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

Reimplemented in resqml2::NonSealedSurfaceFrameworkRepresentation, resqml2::SealedSurfaceFrameworkRepresentation, and resqml2::SealedVolumeFrameworkRepresentation.

◆ getXyzPointCountOfPatch()

uint64_t resqml2::RepresentationSetRepresentation::getXyzPointCountOfPatch ( unsigned int patchIndex ) const

overridevirtual

Please do note use: not implemented yet.

Implements resqml2::AbstractRepresentation.

◆ getXyzPointsOfPatch()

void resqml2::RepresentationSetRepresentation::getXyzPointsOfPatch	(	unsigned int	patchIndex,
		double *	xyzPoints ) const

overridevirtual

Please do note use: not implemented yet.

Implements resqml2::AbstractRepresentation.

◆ isHomogeneous()

bool resqml2::RepresentationSetRepresentation::isHomogeneous ( ) const

Checks if this representation set contains only one type of representations (homogeneous) or several. This methods only read the IsHomogeneous attribute.

Exceptions

std::logic_error If the underlying gSOAP instance is not a RESQML2.0 one.

Returns: True if this representation set is homogeneous, false if not.

◆ loadTargetRelationships()

virtual void resqml2::RepresentationSetRepresentation::loadTargetRelationships ( )

overridevirtual

Loads target relationships

Reimplemented from resqml2::AbstractRepresentation.

◆ pushBack()

void resqml2::RepresentationSetRepresentation::pushBack ( resqml2::AbstractRepresentation * rep )

Pushes back a representation into this representation set. The value of the IsHomogeneous attribute is updated if required (see isHomogeneous).

Exceptions

std::invalid_argument	If `rep` is nullptr.
std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.

Parameters

[in] rep The representation to push in this representation set.

Member Data Documentation

◆ XML_TAG

const char* resqml2::RepresentationSetRepresentation::XML_TAG

static

The standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2/RepresentationSetRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~RepresentationSetRepresentation()

Member Function Documentation

◆ getHdfProxyDor()

◆ getPatchCount()

◆ getRepresentation()

◆ getRepresentationCount()

◆ getRepresentationDor()

◆ getXmlTag()

◆ getXyzPointCountOfPatch()

◆ getXyzPointsOfPatch()

◆ isHomogeneous()

◆ loadTargetRelationships()

◆ pushBack()

Member Data Documentation

◆ XML_TAG