#include <FluidSystem.h>

Inheritance diagram for prodml2_2::FluidSystem:

Public Member Functions
	FluidSystem (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	FluidSystem (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, double temperatureValue, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom temperatureUom, double pressureValue, gsoap_eml2_3::eml23__PressureUom pressureUom, gsoap_eml2_3::prodml22__ReservoirFluidKind reservoirFluidKind, double gasOilRatio, gsoap_eml2_3::eml23__VolumePerVolumeUom gasOilRatioUom)
	Creates an instance of this class in a gsoap context.

	FluidSystem (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, gsoap_eml2_3::eml23__ReferenceCondition referenceCondition, gsoap_eml2_3::prodml22__ReservoirFluidKind reservoirFluidKind, double gasOilRatio, gsoap_eml2_3::eml23__VolumePerVolumeUom gasOilRatioUom)
	Creates an instance of this class in a gsoap context.

	FluidSystem (gsoap_eml2_3::prodml22__FluidSystem *fromGsoap)

	~FluidSystem ()=default

double	getStandardTemperatureValue () const

gsoap_eml2_3::eml23__ThermodynamicTemperatureUom	getStandardTemperatureUom () const

double	getStandardPressureValue () const

gsoap_eml2_3::eml23__PressureUom	getStandardPressureUom () const

double	getSolutionGORValue () const

gsoap_eml2_3::eml23__VolumePerVolumeUom	getSolutionGORUom () const

void	setSaturationPressure (double value, gsoap_eml2_3::eml23__PressureUom pressureUom, gsoap_eml2_3::prodml22__SaturationPointKind saturationPointKind)

bool	hasSaturationPressureValue () const

double	getSaturationPressureValue () const

gsoap_eml2_3::eml23__PressureUom	getSaturationPressureUom () const

gsoap_eml2_3::prodml22__SaturationPointKind	getSaturationPressurePointKind () const

void	setRockFluidOrganization (resqml2::RockFluidOrganizationInterpretation *rockFluidOrg)

common::DataObjectReference	getRockFluidOrganizationDor () const

resqml2::RockFluidOrganizationInterpretation *	getRockFluidOrganization () const

std::vector< class FluidCharacterization * >	getFluidCharacterizationSet () const

uint64_t	getFluidCharacterizationCount () const

class FluidCharacterization *	getFluidCharacterization (uint64_t index) const

virtual std::string	getXmlTag () const

std::string	getXmlNamespace () const final

void	loadTargetRelationships () 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)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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	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)

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

std::vector< eml2::Activity * >	getActivitySet () const

uint64_t	getActivityCount () const

eml2::Activity *	getActivity (uint64_t 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

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

Static Public Attributes
static constexpr char const *	XML_TAG = "FluidSystem"

static constexpr char const *	XML_NS = "prodml22"

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 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 fluid system.

Constructor & Destructor Documentation

◆ FluidSystem() [1/4]

prodml2_2::FluidSystem::FluidSystem ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ FluidSystem() [2/4]

prodml2_2::FluidSystem::FluidSystem	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		double	temperatureValue,
		gsoap_eml2_3::eml23__ThermodynamicTemperatureUom	temperatureUom,
		double	pressureValue,
		gsoap_eml2_3::eml23__PressureUom	pressureUom,
		gsoap_eml2_3::prodml22__ReservoirFluidKind	reservoirFluidKind,
		double	gasOilRatio,
		gsoap_eml2_3::eml23__VolumePerVolumeUom	gasOilRatioUom )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If repo == nullptr.

Parameters

[in,out]	repo	The dataobject repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to this instance. If empty then a new guid will be generated.
	title	The title.
	temperatureValue	The temperature value in standard conditions.
	temperatureUom	The temperature uom.
	pressureValue	The pressure value in standard conditions.
	pressureUom	The pressure uom.
	reservoirFluidKind	The reservoir fluid kind.
	gasOilRatio	The gas oil ratio.
	gasOilRatioUom	The gas oil ratio uom.

◆ FluidSystem() [3/4]

prodml2_2::FluidSystem::FluidSystem	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		gsoap_eml2_3::eml23__ReferenceCondition	referenceCondition,
		gsoap_eml2_3::prodml22__ReservoirFluidKind	reservoirFluidKind,
		double	gasOilRatio,
		gsoap_eml2_3::eml23__VolumePerVolumeUom	gasOilRatioUom )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If repo == nullptr.

Parameters

[in,out]	repo	The dataobject repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to this instance. If empty then a new guid will be generated.
	title	The title.
	referenceCondition	A wellknown couple of temperature-pressure in standard conditions.
	reservoirFluidKind	The reservoir fluid kind.
	gasOilRatio	The gas oil ratio.
	gasOilRatioUom	The gas oil ratio uom.

◆ FluidSystem() [4/4]

prodml2_2::FluidSystem::FluidSystem ( gsoap_eml2_3::prodml22__FluidSystem * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~FluidSystem()

prodml2_2::FluidSystem::~FluidSystem ( )

default

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

Member Function Documentation

◆ getFluidCharacterization()

class FluidCharacterization * prodml2_2::FluidSystem::getFluidCharacterization ( uint64_t index ) const

Gets a particular fluid characterization of this fluid system according to its position in the fluid characterizations ordering.

Exceptions

std::out_of_range If index is out of the range of the representation set.

Parameters

index Zero-based index of the fluid characterization we look for.

Returns: A pointer to the fluid characterization at index.

◆ getFluidCharacterizationCount()

uint64_t prodml2_2::FluidSystem::getFluidCharacterizationCount ( ) const

Get the fluid characterizations count of this fluid system.

Returns: The fluid characterizations count of this fluid system.

◆ getFluidCharacterizationSet()

std::vector< class FluidCharacterization * > prodml2_2::FluidSystem::getFluidCharacterizationSet ( ) const

Gets all the fluid characterizations of this fluid system.

Returns: A vector of all the fluid characterizations of this fluid system.

◆ getRockFluidOrganization()

resqml2::RockFluidOrganizationInterpretation * prodml2_2::FluidSystem::getRockFluidOrganization ( ) const

Gets the associated Rock fluid organization

Returns: Null if it fails, else the associated Rock fluid organization.

◆ getRockFluidOrganizationDor()

common::DataObjectReference prodml2_2::FluidSystem::getRockFluidOrganizationDor ( ) const

Gets the associated Rock fluid organization dor

Returns: Empty if it fails, else the associated Rock fluid organization dor.

◆ getSaturationPressurePointKind()

gsoap_eml2_3::prodml22__SaturationPointKind prodml2_2::FluidSystem::getSaturationPressurePointKind ( ) const

Gets the saturation pressure point kind of this fluid system

Returns: The saturation pressure point kind of this fluid system.

◆ getSaturationPressureUom()

gsoap_eml2_3::eml23__PressureUom prodml2_2::FluidSystem::getSaturationPressureUom ( ) const

Gets the saturation pressure uom of this fluid system

Returns: The saturation pressure uom of this fluid system.

◆ getSaturationPressureValue()

double prodml2_2::FluidSystem::getSaturationPressureValue ( ) const

Gets the saturation pressure of this fluid system

Returns: The saturation pressure of this fluid system.

◆ getSolutionGORUom()

gsoap_eml2_3::eml23__VolumePerVolumeUom prodml2_2::FluidSystem::getSolutionGORUom ( ) const

Gets solution gas-oil ratio uom

Returns: The solution gas-oil ratio uom.

◆ getSolutionGORValue()

double prodml2_2::FluidSystem::getSolutionGORValue ( ) const

Gets solution gas-oil ratio value

Returns: The solution gas-oil ratio value.

◆ getStandardPressureUom()

gsoap_eml2_3::eml23__PressureUom prodml2_2::FluidSystem::getStandardPressureUom ( ) const

Gets standard pressure uom

Returns: The standard pressure uom.

◆ getStandardPressureValue()

double prodml2_2::FluidSystem::getStandardPressureValue ( ) const

Gets standard pressure value

Returns: The standard pressure value.

◆ getStandardTemperatureUom()

gsoap_eml2_3::eml23__ThermodynamicTemperatureUom prodml2_2::FluidSystem::getStandardTemperatureUom ( ) const

Gets standard temperature uom

Returns: The standard temperature uom.

◆ getStandardTemperatureValue()

double prodml2_2::FluidSystem::getStandardTemperatureValue ( ) const

Gets standard temperature value

Returns: The standard temperature value.

◆ getXmlNamespace()

std::string prodml2_2::FluidSystem::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

virtual std::string prodml2_2::FluidSystem::getXmlTag ( ) const

inlinevirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ hasSaturationPressureValue()

bool prodml2_2::FluidSystem::hasSaturationPressureValue ( ) const

Checks if this fluid system has a defined saturation pressure

Returns: True if this fluid system has a defined saturation pressure else false.

◆ loadTargetRelationships()

void prodml2_2::FluidSystem::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Implements common::AbstractObject.

◆ setRockFluidOrganization()

void prodml2_2::FluidSystem::setRockFluidOrganization ( resqml2::RockFluidOrganizationInterpretation * rockFluidOrg )

Formation water Stock tank oil Natural gas Sets the associated Rock fluid organization

Parameters

[in,out] rockFluidUnit If non-null, the rock fluid unit.

◆ setSaturationPressure()

void prodml2_2::FluidSystem::setSaturationPressure	(	double	value,
		gsoap_eml2_3::eml23__PressureUom	pressureUom,
		gsoap_eml2_3::prodml22__SaturationPointKind	saturationPointKind )

Sets the saturation pressure of this fluid system

Member Data Documentation

◆ XML_NS

char const* prodml2_2::FluidSystem::XML_NS = "prodml22"

staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

char const* prodml2_2::FluidSystem::XML_TAG = "FluidSystem"

staticconstexpr

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

Returns: The XML tag.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/prodml2_2/FluidSystem.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FluidSystem() [1/4]

◆ FluidSystem() [2/4]

◆ FluidSystem() [3/4]

◆ FluidSystem() [4/4]

◆ ~FluidSystem()

Member Function Documentation

◆ getFluidCharacterization()

◆ getFluidCharacterizationCount()

◆ getFluidCharacterizationSet()

◆ getRockFluidOrganization()

◆ getRockFluidOrganizationDor()

◆ getSaturationPressurePointKind()

◆ getSaturationPressureUom()

◆ getSaturationPressureValue()

◆ getSolutionGORUom()

◆ getSolutionGORValue()

◆ getStandardPressureUom()

◆ getStandardPressureValue()

◆ getStandardTemperatureUom()

◆ getStandardTemperatureValue()

◆ getXmlNamespace()

◆ getXmlTag()

◆ hasSaturationPressureValue()

◆ loadTargetRelationships()

◆ setRockFluidOrganization()

◆ setSaturationPressure()

Member Data Documentation

◆ XML_NS

◆ XML_TAG