Fesapi  0.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
RESQML2_NS::AbstractFeatureInterpretation Class Reference
Inheritance diagram for RESQML2_NS::AbstractFeatureInterpretation:
COMMON_NS::AbstractObject RESQML2_0_1_NS::AbstractOrganizationInterpretation RESQML2_0_1_NS::BoundaryFeatureInterpretation RESQML2_0_1_NS::EarthModelInterpretation RESQML2_0_1_NS::GenericFeatureInterpretation RESQML2_0_1_NS::GeobodyInterpretation RESQML2_0_1_NS::StratigraphicUnitInterpretation RESQML2_0_1_NS::WellboreInterpretation RESQML2_0_1_NS::AbstractStratigraphicOrganizationInterpretation RESQML2_0_1_NS::StructuralOrganizationInterpretation RESQML2_0_1_NS::FaultInterpretation RESQML2_0_1_NS::GeobodyBoundaryInterpretation RESQML2_0_1_NS::HorizonInterpretation RESQML2_0_1_NS::StratigraphicColumnRankInterpretation RESQML2_0_1_NS::StratigraphicOccurrenceInterpretation

Public Member Functions

virtual ~AbstractFeatureInterpretation ()
 
gsoap_resqml2_0_1::eml20__DataObjectReference * getInterpretedFeatureDor () const
 
std::string getInterpretedFeatureUuid () const
 
void setInterpretedFeature (AbstractFeature *feature)
 
AbstractFeaturegetInterpretedFeature () const
 
const gsoap_resqml2_0_1::resqml2__Domain & initDomain (const gsoap_resqml2_0_1::resqml2__Domain &defaultDomain) const
 
gsoap_resqml2_0_1::resqml2__Domain getDomain () const
 
std::vector< AbstractRepresentation * > getRepresentationSet () const
 
unsigned int getRepresentationCount () const
 
AbstractRepresentationgetRepresentation (const unsigned int &index) const
 
std::vector< GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet ()
 
void setBottomFrontierOf (RESQML2_0_1_NS::StructuralOrganizationInterpretation *structOrg)
 
void setTopFrontierOf (RESQML2_0_1_NS::StructuralOrganizationInterpretation *structOrg)
 
void setSideFrontierOf (RESQML2_0_1_NS::StructuralOrganizationInterpretation *structOrg)
 
- Public Member Functions inherited from COMMON_NS::AbstractObject
bool isPartial () 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 getVersionString () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersionString (const std::string &versionString)
 
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::eml20__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
COMMON_NS::EpcDocumentgetEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getXmlTag () const =0
 
virtual std::string getResqmlVersion () const
 
virtual std::string getContentType () 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 (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< RESQML2_NS::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
RESQML2_NS::ActivitygetActivity (const unsigned int &index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::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 (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Protected Member Functions

 AbstractFeatureInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractFeatureInterpretation ()
 
 AbstractFeatureInterpretation (gsoap_resqml2_0_1::resqml2__AbstractFeatureInterpretation *fromGsoap)
 
void setInterpretedFeatureInXml (RESQML2_NS::AbstractFeature *feature)
 
virtual std::vector< epc::RelationshipgetAllEpcRelationships () const
 
virtual void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from COMMON_NS::AbstractObject
 AbstractObject ()
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
 
 AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
 
 AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
 
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)
 
void cannotBePartial () const
 
void changeToPartialObject ()
 

Protected Attributes

std::vector< AbstractRepresentation * > representationSet
 
std::vector< GridConnectionSetRepresentation * > gridConnectionSetRepresentationSet
 
std::vector< RESQML2_0_1_NS::StructuralOrganizationInterpretation * > isBottomFrontierSet
 
std::vector< RESQML2_0_1_NS::StructuralOrganizationInterpretation * > isTopFrontierSet
 
std::vector< RESQML2_0_1_NS::StructuralOrganizationInterpretation * > isSideFrontierSet
 
- Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
COMMON_NS::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Friends

void AbstractRepresentation::setInterpretation (AbstractFeatureInterpretation *interp)
 
void GridConnectionSetRepresentation::pushBackInterpretation (AbstractFeatureInterpretation *interp)
 

Additional Inherited Members

- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

RESQML2_NS::AbstractFeatureInterpretation::AbstractFeatureInterpretation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inlineprotected

Only to be used in partial transfer context

RESQML2_NS::AbstractFeatureInterpretation::AbstractFeatureInterpretation ( )
inlineprotected

Default constructor Set the gsoap proxy to nullptr.

RESQML2_NS::AbstractFeatureInterpretation::AbstractFeatureInterpretation ( gsoap_resqml2_0_1::resqml2__AbstractFeatureInterpretation *  fromGsoap)
inlineprotected

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

virtual RESQML2_NS::AbstractFeatureInterpretation::~AbstractFeatureInterpretation ( )
inlinevirtual

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

Member Function Documentation

vector< Relationship > AbstractFeatureInterpretation::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Implements COMMON_NS::AbstractObject.

Reimplemented in RESQML2_0_1_NS::BoundaryFeatureInterpretation, and RESQML2_0_1_NS::AbstractStratigraphicOrganizationInterpretation.

gsoap_resqml2_0_1::resqml2__Domain AbstractFeatureInterpretation::getDomain ( ) const

Set the domain of the interpretation

vector< GridConnectionSetRepresentation * > AbstractFeatureInterpretation::getGridConnectionSetRepresentationSet ( )

Get all the Grid Connection Set Representation which reference this interpretation.

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

Get the feature this instance interprets

gsoap_resqml2_0_1::eml20__DataObjectReference * AbstractFeatureInterpretation::getInterpretedFeatureDor ( ) const
Returns
null pointer if no interpreted feature is associated to this interpretation. Otherwise return the data objet reference of the associated interpreted feature.
AbstractRepresentation * AbstractFeatureInterpretation::getRepresentation ( const unsigned int &  index) const

Get a particular interpretation of this feature according to its position in the interpretation ordering.

unsigned int AbstractFeatureInterpretation::getRepresentationCount ( ) const

Get the interpretation count of this feature.

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

Get all the representations of this interpretation

void AbstractFeatureInterpretation::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument epcDoc)
protectedvirtual

Resolve all relationships of the object in an epc document

Implements COMMON_NS::AbstractObject.

const gsoap_resqml2_0_1::resqml2__Domain & AbstractFeatureInterpretation::initDomain ( const gsoap_resqml2_0_1::resqml2__Domain &  defaultDomain) const

Init the domain of the interpretation based on its representations

Parameters
defaultDomainThe default domain to set when there is no representation set to this interpretation
void AbstractFeatureInterpretation::setBottomFrontierOf ( RESQML2_0_1_NS::StructuralOrganizationInterpretation structOrg)

Indicates that this interpretation is a frontier of a stack of an organization BE CAREFUL : Does not add back this instance to the organization. It is assumed it is already done.

void AbstractFeatureInterpretation::setInterpretedFeature ( RESQML2_NS::AbstractFeature feature)

Set the feature which is interpreted by the current instance.


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