resqml2::RepresentationSetRepresentation Class Reference

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

Static Public Attributes
static const char *	XML_TAG

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.

Member Function Documentation

getHdfProxyDor()

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

inlinefinal

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.

getPatchCount()

uint64_t resqml2::RepresentationSetRepresentation::getPatchCount ( ) const

inlineoverride

Gets the patch count.

Returns

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

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.

getXyzPointCountOfPatch()

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

override

Please do note use: not implemented yet.

getXyzPointsOfPatch()

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

override

Please do note use: not implemented yet.

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

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.9.0.1/src/resqml2/RepresentationSetRepresentation.h