My Project
Public Member Functions | Static Public Attributes | Friends | List of all members
resqml2_0_1::StratigraphicColumnRankInterpretation Class Reference

#include <StratigraphicColumnRankInterpretation.h>

Inheritance diagram for resqml2_0_1::StratigraphicColumnRankInterpretation:
resqml2_0_1::AbstractStratigraphicOrganizationInterpretation resqml2_0_1::AbstractOrganizationInterpretation resqml2::AbstractFeatureInterpretation common::AbstractObject

Public Member Functions

 StratigraphicColumnRankInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 StratigraphicColumnRankInterpretation (class OrganizationFeature *orgFeat, const std::string &guid, const std::string &title, const unsigned long &rank, const gsoap_resqml2_0_1::resqml2__OrderingCriteria &orderingCriteria)
 
 StratigraphicColumnRankInterpretation (gsoap_resqml2_0_1::_resqml2__StratigraphicColumnRankInterpretation *fromGsoap)
 
 ~StratigraphicColumnRankInterpretation ()
 
void pushBackStratiUnitInterpretation (class StratigraphicUnitInterpretation *stratiUnitInterpretation)
 
void setHorizonOfLastContact (class HorizonInterpretation *partOf)
 
void pushBackStratigraphicBinaryContact (StratigraphicUnitInterpretation *subject, const gsoap_resqml2_0_1::resqml2__ContactMode &subjectContactMode, StratigraphicUnitInterpretation *directObject, const gsoap_resqml2_0_1::resqml2__ContactMode &directObjectMode, class HorizonInterpretation *partOf=nullptr)
 
bool isAChronoStratiRank () const
 
unsigned int getContactCount () const
 
gsoap_resqml2_0_1::resqml2__ContactMode getSubjectContactModeOfContact (const unsigned int &contactIndex) const
 
class StratigraphicUnitInterpretationgetSubjectOfContact (const unsigned int &contactIndex) const
 
gsoap_resqml2_0_1::resqml2__ContactMode getDirectObjectContactModeOfContact (const unsigned int &contactIndex) const
 
class StratigraphicUnitInterpretationgetDirectObjectOfContact (const unsigned int &contactIndex) const
 
class HorizonInterpretationgetHorizonInterpretationOfContact (const unsigned int &contactIndex) const
 
const std::vector< class StratigraphicUnitInterpretation * > & getStratigraphicUnitInterpretationSet () const
 
const std::vector< class StratigraphicOccurrenceInterpretation * > & getStratigraphicOccurrenceInterpretationSet () const
 
const std::vector< class HorizonInterpretation * > & getHorizonInterpretationSet () const
 
const std::vector< StratigraphicColumn * > & getStratigraphicColumnSet () const
 
virtual std::string getXmlTag () const
 
- Public Member Functions inherited from resqml2_0_1::AbstractStratigraphicOrganizationInterpretation
virtual ~AbstractStratigraphicOrganizationInterpretation ()
 
unsigned int getGridRepresentationCount () const
 
resqml2::AbstractGridRepresentationgetGridRepresentation (const unsigned int &index) const
 
bool isAssociatedToGridRepresentation (resqml2::AbstractGridRepresentation *gridRep) const
 
- Public Member Functions inherited from resqml2_0_1::AbstractOrganizationInterpretation
virtual ~AbstractOrganizationInterpretation ()
 
void pushBackBinaryContact (const gsoap_resqml2_0_1::resqml2__ContactRelationship &kind, resqml2::AbstractFeatureInterpretation *subject, const gsoap_resqml2_0_1::resqml2__ContactVerb &verb, resqml2::AbstractFeatureInterpretation *directObject)
 
void pushBackBinaryContact (const gsoap_resqml2_0_1::resqml2__ContactRelationship &kind, resqml2::AbstractFeatureInterpretation *subject, const gsoap_resqml2_0_1::resqml2__ContactVerb &verb, resqml2::AbstractFeatureInterpretation *directObject, const gsoap_resqml2_0_1::resqml2__ContactSide &directObjectQualifier)
 
void pushBackBinaryContact (const gsoap_resqml2_0_1::resqml2__ContactRelationship &kind, resqml2::AbstractFeatureInterpretation *subject, const gsoap_resqml2_0_1::resqml2__ContactSide &subjectQualifier, const gsoap_resqml2_0_1::resqml2__ContactVerb &verb, resqml2::AbstractFeatureInterpretation *directObject, const gsoap_resqml2_0_1::resqml2__ContactSide &directObjectQualifier)
 
- Public Member Functions inherited from resqml2::AbstractFeatureInterpretation
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::StructuralOrganizationInterpretation *structOrg)
 
void setTopFrontierOf (resqml2_0_1::StructuralOrganizationInterpretation *structOrg)
 
void setSideFrontierOf (resqml2_0_1::StructuralOrganizationInterpretation *structOrg)
 
- Public Member Functions inherited from common::AbstractObject
bool isPartial () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
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::EpcDocumentgetEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
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::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
resqml2::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
 

Static Public Attributes

static const char * XML_TAG = "StratigraphicColumnRankInterpretation"
 

Friends

void StratigraphicColumn::pushBackStratiColumnRank (StratigraphicColumnRankInterpretation *stratiColumnRank)
 
void StratigraphicOccurrenceInterpretation::setStratigraphicColumnRankInterpretation (StratigraphicColumnRankInterpretation *stratiColumnRankInterp)
 

Additional Inherited Members

- Protected Types inherited from common::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Protected Member Functions inherited from resqml2_0_1::AbstractStratigraphicOrganizationInterpretation
 AbstractStratigraphicOrganizationInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractStratigraphicOrganizationInterpretation (gsoap_resqml2_0_1::resqml2__AbstractStratigraphicOrganizationInterpretation *fromGsoap)
 
- Protected Member Functions inherited from resqml2_0_1::AbstractOrganizationInterpretation
 AbstractOrganizationInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractOrganizationInterpretation (gsoap_resqml2_0_1::resqml2__AbstractOrganizationInterpretation *fromGsoap)
 
- Protected Member Functions inherited from resqml2::AbstractFeatureInterpretation
 AbstractFeatureInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractFeatureInterpretation ()
 
 AbstractFeatureInterpretation (gsoap_resqml2_0_1::resqml2__AbstractFeatureInterpretation *fromGsoap)
 
void setInterpretedFeatureInXml (resqml2::AbstractFeature *feature)
 
- Protected Member Functions inherited from common::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 ()
 
- Static Protected Member Functions inherited from common::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from resqml2::AbstractFeatureInterpretation
std::vector< AbstractRepresentation * > representationSet
 
std::vector< GridConnectionSetRepresentation * > gridConnectionSetRepresentationSet
 
std::vector< resqml2_0_1::StructuralOrganizationInterpretation * > isBottomFrontierSet
 
std::vector< resqml2_0_1::StructuralOrganizationInterpretation * > isTopFrontierSet
 
std::vector< resqml2_0_1::StructuralOrganizationInterpretation * > isSideFrontierSet
 
- Protected Attributes inherited from common::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
common::EpcDocumentepcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Detailed Description

This class is a container for other organizations that are consistent to each others.

Constructor & Destructor Documentation

resqml2_0_1::StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( class OrganizationFeature orgFeat,
const std::string &  guid,
const std::string &  title,
const unsigned long &  rank,
const gsoap_resqml2_0_1::resqml2__OrderingCriteria &  orderingCriteria 
)

Creates an instance of this class in a gsoap context.

Parameters
orgFeatThe feature the instance interprets. It must be a stratigraphic organization feature.
guidThe guid to set to the interpretation. If empty then a new guid will be generated.
titleA title for the instance to create.
rankThe rank index of this interpretation within a stratigraphic column
orderingCriteriaHow the included horizons are ordered.
resqml2_0_1::StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( gsoap_resqml2_0_1::_resqml2__StratigraphicColumnRankInterpretation *  fromGsoap)
inline

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

resqml2_0_1::StratigraphicColumnRankInterpretation::~StratigraphicColumnRankInterpretation ( )
inline

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

Member Function Documentation

unsigned int StratigraphicColumnRankInterpretation::getContactCount ( ) const

Get the count of contacts in this strati column rank interp.

resqml2__ContactMode StratigraphicColumnRankInterpretation::getDirectObjectContactModeOfContact ( const unsigned int &  contactIndex) const

Get the contact mode between the direct object strati unit and the contact located at a particular index. Most of time the subject strati unit is the strati unit below the contact.

Returns
proportional contact mode by default or the contact mode of the direct object.
StratigraphicUnitInterpretation * StratigraphicColumnRankInterpretation::getDirectObjectOfContact ( const unsigned int &  contactIndex) const

Get the strati unt interpretation which is the direct object of a particular contact.

HorizonInterpretation * StratigraphicColumnRankInterpretation::getHorizonInterpretationOfContact ( const unsigned int &  contactIndex) const

Get the horizon interpretation which is the contact between two strati units.

const std::vector< class HorizonInterpretation * > & StratigraphicColumnRankInterpretation::getHorizonInterpretationSet ( ) const

Get all the horizon interpretations contained in this StratigraphicColumnRankInterpretation.

const std::vector< StratigraphicColumn * > & StratigraphicColumnRankInterpretation::getStratigraphicColumnSet ( ) const

Get all the stratigraphic column this strati column rank belongs to.

const std::vector< class StratigraphicOccurrenceInterpretation * > & StratigraphicColumnRankInterpretation::getStratigraphicOccurrenceInterpretationSet ( ) const

Get all the stratigraphic occurence interpretations associated with this StratigraphicColumnRankInterpretation.

const std::vector< class StratigraphicUnitInterpretation * > & StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationSet ( ) const

Get all the stratigraphic unit interpretations contained in this StratigraphicColumnRankInterpretation.

resqml2__ContactMode StratigraphicColumnRankInterpretation::getSubjectContactModeOfContact ( const unsigned int &  contactIndex) const

Get the contact mode between the subject strati unit and the contact located at a particular index. Most of time the subject strati unit is the strati unit on top of the contact.

Returns
proportional contact mode by default or the contact mode of the subject.
StratigraphicUnitInterpretation * StratigraphicColumnRankInterpretation::getSubjectOfContact ( const unsigned int &  contactIndex) const

Get the strati unt interpretation which is the subject of a particular contact.

virtual std::string resqml2_0_1::StratigraphicColumnRankInterpretation::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

bool StratigraphicColumnRankInterpretation::isAChronoStratiRank ( ) const

Indicates if this strati column rank interp is wether a chrono one or not. One of the consequence is that in a chrono strati column rank interp, each strati unit interp have only one top and only one bottom.

void StratigraphicColumnRankInterpretation::pushBackStratigraphicBinaryContact ( StratigraphicUnitInterpretation subject,
const gsoap_resqml2_0_1::resqml2__ContactMode &  subjectContactMode,
StratigraphicUnitInterpretation directObject,
const gsoap_resqml2_0_1::resqml2__ContactMode &  directObjectMode,
class HorizonInterpretation partOf = nullptr 
)

Add a stratigraphic binary contact to the organization interpretation.

void StratigraphicColumnRankInterpretation::pushBackStratiUnitInterpretation ( class StratigraphicUnitInterpretation stratiUnitInterpretation)

Add a StratiUnitInterp to this StratigraphicColumnRankInterpretation. Does add the inverse relationship i.e. from the included StratiUnitInterp to this StratigraphicColumnRankInterpretation.


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