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 | Static Public Attributes | List of all members
resqml2::StratigraphicColumn Class Referenceabstract

A global interpretation of the stratigraphy, which can be made up of several ranks of stratigraphic unit interpretations. More...

#include <StratigraphicColumn.h>

Inheritance diagram for resqml2::StratigraphicColumn:
common::AbstractObject resqml2_0_1::StratigraphicColumn resqml2_2::StratigraphicColumn

Public Member Functions

virtual ~StratigraphicColumn ()=default
 
virtual void pushBackStratiColumnRank (StratigraphicColumnRankInterpretation *stratiColumnRank)=0
 
virtual unsigned int getStratigraphicColumnRankInterpretationCount () const =0
 
virtual common::DataObjectReference getStratigraphicColumnRankInterpretationDor (unsigned int index) const =0
 
StratigraphicColumnRankInterpretation * getStratigraphicColumnRankInterpretation (unsigned int index) const
 
std::vector< StratigraphicColumnRankInterpretation * > getStratigraphicColumnRankInterpretationSet () const
 
virtual std::string getXmlTag () const final
 
- 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::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)
 
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::Activity * getActivity (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
 

Static Public Attributes

static const char * XML_TAG
 

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

A global interpretation of the stratigraphy, which can be made up of several ranks of stratigraphic unit interpretations.

BUSINESS RULE: All stratigraphic column rank interpretations that make up a stratigraphic column must be ordered by age.

Constructor & Destructor Documentation

◆ ~StratigraphicColumn()

virtual resqml2::StratigraphicColumn::~StratigraphicColumn ( )
virtualdefault

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

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

Member Function Documentation

◆ getStratigraphicColumnRankInterpretation()

StratigraphicColumnRankInterpretation* resqml2::StratigraphicColumn::getStratigraphicColumnRankInterpretation ( unsigned int  index) const

Gets the stratigraphic column rank interpretations at a particular index.

Exceptions
std::out_of_rangeIf index >= getStratigraphicColumnRankInterpretationCount().
Parameters
indexZero-based index of the stratigraphic column rank interpretations.
Returns
The stratigraphic column rank interpretation at position index.

◆ getStratigraphicColumnRankInterpretationCount()

virtual unsigned int resqml2::StratigraphicColumn::getStratigraphicColumnRankInterpretationCount ( ) const
pure virtual

Gets the count of all the stratigraphic column rank interpretations which are contained in this stratigraphic column.

Returns
The count of all the stratigraphic column rank interpretations which are contained in this stratigraphic column.

Implemented in resqml2_2::StratigraphicColumn, and resqml2_0_1::StratigraphicColumn.

◆ getStratigraphicColumnRankInterpretationDor()

virtual common::DataObjectReference resqml2::StratigraphicColumn::getStratigraphicColumnRankInterpretationDor ( unsigned int  index) const
pure virtual

Gets the DOR of a stratigraphic column rank interpretations at a particular index.

Exceptions
std::out_of_rangeIf index >= getStratigraphicColumnRankInterpretationCount().
Parameters
indexZero-based index of the stratigraphic column rank interpretations.
Returns
The DOR of the stratigraphic column rank interpretation at position index.

Implemented in resqml2_2::StratigraphicColumn, and resqml2_0_1::StratigraphicColumn.

◆ getStratigraphicColumnRankInterpretationSet()

std::vector<StratigraphicColumnRankInterpretation *> resqml2::StratigraphicColumn::getStratigraphicColumnRankInterpretationSet ( ) const

Gets all the stratigraphic column rank interpretations which are contained in this stratigraphic column.

Returns
A vector of pointers to all the stratigraphic column rank interpretations which are contained in this stratigraphic column.

◆ getXmlTag()

virtual std::string resqml2::StratigraphicColumn::getXmlTag ( ) const
inlinefinalvirtual

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

Returns
The XML tag.

Implements common::AbstractObject.

◆ pushBackStratiColumnRank()

virtual void resqml2::StratigraphicColumn::pushBackStratiColumnRank ( StratigraphicColumnRankInterpretation *  stratiColumnRank)
pure virtual

Pushes a back a stratigraphic column rank interpretation into this stratigraphic column.

Exceptions
std::invalid_argumentIf stratiColumnRank == nullptr
Parameters
[in]stratiColumnRankA stratigraphic column rank interpretation.

Implemented in resqml2_2::StratigraphicColumn, and resqml2_0_1::StratigraphicColumn.

Member Data Documentation

◆ XML_TAG

const char* resqml2::StratigraphicColumn::XML_TAG
static

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

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.0