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_2::StreamlinesFeature Class Referencefinal

Specification of the vector field upon which the streamlines are based. More...

#include <StreamlinesFeature.h>

Inheritance diagram for resqml2_2::StreamlinesFeature:
resqml2::StreamlinesFeature resqml2::AbstractTechnicalFeature resqml2::AbstractFeature common::AbstractObject

Public Member Functions

 StreamlinesFeature (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 StreamlinesFeature (gsoap_eml2_3::_resqml22__StreamlinesFeature *fromGsoap)
 
 StreamlinesFeature (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, uint64_t timeIndex, eml2::TimeSeries *timeSeries)
 Construct a streamlines feature into a repository. More...
 
 ~StreamlinesFeature ()=default
 
uint64_t getTimeIndex () const final
 
common::DataObjectReference getTimeSeriesDor () const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::StreamlinesFeature
 StreamlinesFeature (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 StreamlinesFeature (gsoap_resqml2_0_1::_resqml20__StreamlinesFeature *fromGsoap)
 
 StreamlinesFeature (gsoap_eml2_3::_resqml22__StreamlinesFeature *fromGsoap)
 
eml2::TimeSeriesgetTimeSeries () const
 
void loadTargetRelationships () final
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::AbstractTechnicalFeature
virtual ~AbstractTechnicalFeature ()=default
 
- Public Member Functions inherited from resqml2::AbstractFeature
virtual ~AbstractFeature ()=default
 
std::vector< AbstractFeatureInterpretation * > getInterpretationSet () const
 
unsigned int getInterpretationCount () const
 
AbstractFeatureInterpretationgetInterpretation (unsigned int index) const
 
- 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 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
 

Static Public Attributes

static const char * XML_NS
 
- Static Public Attributes inherited from resqml2::StreamlinesFeature
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

Specification of the vector field upon which the streamlines are based.

        Streamlines are commonly used to trace the flow of phases (water / oil / gas / total)
    based upon their flux at a specified time. They may also be used for trace components
    for compositional simulation, e.g., CO2, or temperatures for thermal simulation.

Constructor & Destructor Documentation

◆ StreamlinesFeature() [1/3]

resqml2_2::StreamlinesFeature::StreamlinesFeature ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context.

Parameters
[in]partialObjectIf non-nullptr, the partial object.

◆ StreamlinesFeature() [2/3]

resqml2_2::StreamlinesFeature::StreamlinesFeature ( gsoap_eml2_3::_resqml22__StreamlinesFeature *  fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ StreamlinesFeature() [3/3]

resqml2_2::StreamlinesFeature::StreamlinesFeature ( common::DataObjectRepository repo,
const std::string &  guid,
const std::string &  title,
uint64_t  timeIndex,
eml2::TimeSeries timeSeries 
)

Construct a streamlines feature into a repository.

Exceptions
std::invalid_argumentIf the default RESQML version is unrecognized.
Parameters
guidThe guid to set to the streamlines feature. If empty then a new guid will be generated.
titleThe title to set to the streamlines feature. If empty then "unknown" title will be set.
timeIndexThe time index in the time series of the this streamlines feature.
timeSeriesThe time series where the time index of this streamlines feature is given.

◆ ~StreamlinesFeature()

resqml2_2::StreamlinesFeature::~StreamlinesFeature ( )
virtualdefault

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

Reimplemented from resqml2::StreamlinesFeature.

Member Function Documentation

◆ getTimeIndex()

uint64_t resqml2_2::StreamlinesFeature::getTimeIndex ( ) const
finalvirtual

Gets the time index in the Time series associated to this streamlines feature.

Exceptions
std::logic_errorIf this feature is partial.
Returns
the time index in the Time series associated to this streamlines feature

Implements resqml2::StreamlinesFeature.

◆ getTimeSeriesDor()

common::DataObjectReference resqml2_2::StreamlinesFeature::getTimeSeriesDor ( ) const
finalvirtual

Gets the Time series DOR associated to this streamlines feature.

Exceptions
std::logic_errorIf this feature is partial or if this feature is standard invalid.
Returns
The associated streamlines feature DOR.

Implements resqml2::StreamlinesFeature.

◆ getXmlNamespace()

std::string resqml2_2::StreamlinesFeature::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::StreamlinesFeature::XML_NS
static

The standard XML namespace for serializing this data object.


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