resqml2_2::StreamlinesFeature Class Reference

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

#include <StreamlinesFeature.h>

Inheritance diagram for resqml2_2::StreamlinesFeature:

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.
	~StreamlinesFeature ()=default
uint64_t	getTimeIndex () const final
common::DataObjectReference	getTimeSeriesDor () const final
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

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]

partialObject

If 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]

fromGsoap

If 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_argument

If the default RESQML version is unrecognized.

Parameters

guid	The guid to set to the streamlines feature. If empty then a new guid will be generated.
title	The title to set to the streamlines feature. If empty then "unknown" title will be set.
timeIndex	The time index in the time series of the this streamlines feature.
timeSeries	The time series where the time index of this streamlines feature is given.

~StreamlinesFeature()

resqml2_2::StreamlinesFeature::~StreamlinesFeature ( )

default

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

Member Function Documentation

getTimeIndex()

uint64_t resqml2_2::StreamlinesFeature::getTimeIndex ( ) const

final

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

Exceptions

std::logic_error

If this feature is partial.

Returns

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

getTimeSeriesDor()

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

final

Gets the Time series DOR associated to this streamlines feature.

Exceptions

std::logic_error

If this feature is partial or if this feature is standard invalid.

Returns

The associated streamlines feature DOR.

getXmlNamespace()

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

inlinefinal

Get the standard XML namespace for serializing this data object.

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:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2_2/StreamlinesFeature.h