Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
resqml2::AbstractFeatureInterpretation Class Reference

Proxy class for an abstract feature interpretation. More...

#include <AbstractFeatureInterpretation.h>

Inheritance diagram for resqml2::AbstractFeatureInterpretation:
resqml2::AbstractOrganizationInterpretation resqml2::BoundaryFeatureInterpretation resqml2::EarthModelInterpretation resqml2::StratigraphicUnitInterpretation resqml2::WellboreInterpretation resqml2::AbstractStratigraphicOrganizationInterpretation resqml2::RockFluidOrganizationInterpretation resqml2::StructuralOrganizationInterpretation resqml2::FaultInterpretation resqml2::FluidBoundaryInterpretation resqml2::GeobodyBoundaryInterpretation resqml2::HorizonInterpretation resqml2::StratigraphicColumnRankInterpretation resqml2::StratigraphicOccurrenceInterpretation

Public Member Functions

virtual ~AbstractFeatureInterpretation ()=default
 
common::DataObjectReference getInterpretedFeatureDor () const
 
void setInterpretedFeature (AbstractFeature *feature)
 
AbstractFeaturegetInterpretedFeature () const
 
gsoap_resqml2_0_1::resqml20__Domain initDomain (gsoap_resqml2_0_1::resqml20__Domain defaultDomain) const
 
gsoap_resqml2_0_1::resqml20__Domain getDomain () const
 
std::vector< AbstractRepresentation * > getRepresentationSet () const
 
uint64_t getRepresentationCount () const noexcept
 
AbstractRepresentationgetRepresentation (uint64_t index) const
 
std::vector< GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet () const
 
virtual void loadTargetRelationships () override
 

Detailed Description

Proxy class for an abstract feature interpretation.

Constructor & Destructor Documentation

◆ ~AbstractFeatureInterpretation()

virtual resqml2::AbstractFeatureInterpretation::~AbstractFeatureInterpretation ( )
virtualdefault

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

Member Function Documentation

◆ getDomain()

gsoap_resqml2_0_1::resqml20__Domain resqml2::AbstractFeatureInterpretation::getDomain ( ) const

Gets the domain of this interpretation.

Returns
The domain of this interpretation.

◆ getGridConnectionSetRepresentationSet()

std::vector< GridConnectionSetRepresentation * > resqml2::AbstractFeatureInterpretation::getGridConnectionSetRepresentationSet ( ) const

Get all the grid connection set representations which reference this interpretation.

Returns
A vector of pointers to all the grid connection set representations which reference this interpretation.

◆ getInterpretedFeature()

AbstractFeature * resqml2::AbstractFeatureInterpretation::getInterpretedFeature ( ) const

Gets the feature this instance interprets

Returns
A pointer to the interpreted feature.

◆ getInterpretedFeatureDor()

common::DataObjectReference resqml2::AbstractFeatureInterpretation::getInterpretedFeatureDor ( ) const

Gets the interpreted feature data object reference.

Returns
Empty data object reference if no interpreted feature is associated to this interpretation. Otherwise return the data objet reference of the associated interpreted feature.

◆ getRepresentation()

AbstractRepresentation * resqml2::AbstractFeatureInterpretation::getRepresentation ( uint64_t index) const
inline

Gets a particular representation of this interpretation according to its position in the representations ordering.

Exceptions
std::out_of_rangeIf index is out of the range of the representation set.
Parameters
indexZero-based index of the representation we look for.
Returns
A pointer to the representation at index.

◆ getRepresentationCount()

uint64_t resqml2::AbstractFeatureInterpretation::getRepresentationCount ( ) const
inlinenoexcept

Get the representation count of this interpretation.

Exceptions
std::range_errorIf the representation count is strictly greater than unsigned int max.
Returns
The representation count.

◆ getRepresentationSet()

std::vector< AbstractRepresentation * > resqml2::AbstractFeatureInterpretation::getRepresentationSet ( ) const

Gets all the representations of this interpretation.

Returns
A vector of all the representations associated to this interpretation.

◆ initDomain()

gsoap_resqml2_0_1::resqml20__Domain resqml2::AbstractFeatureInterpretation::initDomain ( gsoap_resqml2_0_1::resqml20__Domain defaultDomain) const

Initializes the domain of the interpretation by looking at the local CRS domain of its representations.

Parameters
defaultDomainThe default domain to set when no representation is associated to this interpretation.
Returns
The domain that have been set to this interpretation (either deduced from its representation or defaultDomain).

◆ loadTargetRelationships()

virtual void resqml2::AbstractFeatureInterpretation::loadTargetRelationships ( )
overridevirtual

Loads target relationships

◆ setInterpretedFeature()

void resqml2::AbstractFeatureInterpretation::setInterpretedFeature ( AbstractFeature * feature)

Sets the feature which is interpreted by the current instance.

Exceptions
std::invalid_argumentIf feature is null.
Parameters
[in]featureThe feature to interpret.

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