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 | Public Attributes | List of all members
prodml2_1::PvtSpecification Class Reference

#include <PvtSpecification.h>

Inheritance diagram for prodml2_1::PvtSpecification:
prodml2_1::CompositionalSpecification prodml2_1::CorrelationViscositySpecification prodml2_1::CompositionalViscositySpecification prodml2_1::CorrelationViscosityBubblePointSpecification prodml2_1::FrictionTheorySpecification

Public Member Functions

 PvtSpecification (gsoap_eml2_2::prodml21__AbstractPvtModel *fromGsoap)
 
virtual ~PvtSpecification ()=default
 
unsigned int getCoefficientCount () const
 
double getCoefficientValue (unsigned int index) const
 
gsoap_eml2_2::prodml21__PvtModelParameterKind getCoefficientKind (unsigned int index) const
 
bool hasCoefficientName (unsigned int index) const
 
std::string getCoefficientName (unsigned int index) const
 
void pushBackCoefficient (double value, gsoap_eml2_2::prodml21__PvtModelParameterKind kind, const std::string &name="")
 

Public Attributes

gsoap_eml2_2::prodml21__AbstractPvtModel * gsoapProxy
 

Detailed Description

A pvt specification.

Constructor & Destructor Documentation

◆ PvtSpecification()

prodml2_1::PvtSpecification::PvtSpecification ( gsoap_eml2_2::prodml21__AbstractPvtModel *  fromGsoap)
inline

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

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~PvtSpecification()

virtual prodml2_1::PvtSpecification::~PvtSpecification ( )
virtualdefault

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

Member Function Documentation

◆ getCoefficientCount()

unsigned int prodml2_1::PvtSpecification::getCoefficientCount ( ) const
inline

Gets coefficient count

Exceptions
std::out_of_rangeThrown when an out of range error condition occurs.
Returns
The coefficient count.

◆ getCoefficientKind()

gsoap_eml2_2::prodml21__PvtModelParameterKind prodml2_1::PvtSpecification::getCoefficientKind ( unsigned int  index) const

Gets coefficient kind

Parameters
indexZero-based index of the.
Returns
The coefficient kind.

◆ getCoefficientName()

std::string prodml2_1::PvtSpecification::getCoefficientName ( unsigned int  index) const
inline

Gets coefficient name

Exceptions
std::invalid_argumentThrown when an invalid argument error condition occurs.
Parameters
indexZero-based index of the.
Returns
The coefficient name.

◆ getCoefficientValue()

double prodml2_1::PvtSpecification::getCoefficientValue ( unsigned int  index) const
inline

Gets coefficient value

Exceptions
std::out_of_rangeThrown when an out of range error condition occurs.
Parameters
indexZero-based index of the.
Returns
The coefficient value.

◆ hasCoefficientName()

bool prodml2_1::PvtSpecification::hasCoefficientName ( unsigned int  index) const
inline

Query if 'index' has coefficient name

Exceptions
std::out_of_rangeThrown when an out of range error condition occurs.
Parameters
indexZero-based index of the.
Returns
True if coefficient name, false if not.

◆ pushBackCoefficient()

void prodml2_1::PvtSpecification::pushBackCoefficient ( double  value,
gsoap_eml2_2::prodml21__PvtModelParameterKind  kind,
const std::string &  name = "" 
)

Pushes a back coefficient

Parameters
valueThe value.
kindThe kind.
name(Optional) The name.

Member Data Documentation

◆ gsoapProxy

gsoap_eml2_2::prodml21__AbstractPvtModel* prodml2_1::PvtSpecification::gsoapProxy

The gsoap proxy


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