resqml2::StratigraphicColumn Class Reference

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:

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

Static Public Attributes
static const char *	XML_TAG

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.

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_range

If index >= getStratigraphicColumnRankInterpretationCount().

Parameters

index

Zero-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.

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_range

If index >= getStratigraphicColumnRankInterpretationCount().

Parameters

index

Zero-based index of the stratigraphic column rank interpretations.

Returns

The DOR of the stratigraphic column rank interpretation at position index.

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.

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_argument

If stratiColumnRank == nullptr

Parameters

[in]

stratiColumnRank

A stratigraphic column rank interpretation.

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:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2/StratigraphicColumn.h