Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
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:
common::AbstractObject resqml2::AbstractOrganizationInterpretation resqml2::BoundaryFeatureInterpretation resqml2::EarthModelInterpretation resqml2::GenericFeatureInterpretation resqml2::GeobodyInterpretation resqml2::RockFluidUnitInterpretation resqml2::StratigraphicUnitInterpretation resqml2::WellboreInterpretation

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
 
unsigned int getRepresentationCount () const
 
std::vector< GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet () const
 
AbstractRepresentationgetRepresentation (unsigned int index) const
 
virtual void loadTargetRelationships ()
 
- 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)
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
 
void setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
gsoap_eml2_1::eml21__AbstractObject * getEml21GsoapProxy () const
 
gsoap_eml2_2::eml22__AbstractObject * getEml22GsoapProxy () const
 
void setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_eml2_2::eml22__DataObjectReference * newEml22Reference () 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::DataObjectRepositorygetRepository () const
 
virtual std::string getXmlNamespace () const =0
 
virtual std::string getXmlTag () 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)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (unsigned int index) const
 
std::string getAliasTitleAtIndex (unsigned int index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
unsigned int getActivityCount () const
 
eml2::ActivitygetActivity (unsigned int 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
 

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum  hdfDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 ,
  ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 ,
  USHORT = 8 , CHAR = 9 , UCHAR = 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 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 ( unsigned int  index) const

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

unsigned int resqml2::AbstractFeatureInterpretation::getRepresentationCount ( ) const

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 ( )
virtual

Loads target relationships

Implements common::AbstractObject.

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