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 | List of all members
common::EnumStringMapper Class Reference

A class for mapping enum values with strings. More...

#include <EnumStringMapper.h>

Public Member Functions

 EnumStringMapper ()
 
 ~EnumStringMapper ()
 
std::string getEnergisticsPropertyKindName (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind) const
 
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getEnergisticsPropertyKind (const std::string &energisticsPropertyKindName) const
 
std::string getEnergisticsUnitOfMeasureName (gsoap_resqml2_0_1::resqml20__ResqmlUom energisticsUom) const
 
gsoap_resqml2_0_1::resqml20__ResqmlUom getEnergisticsUnitOfMeasure (const std::string &energisticsUomName) const
 
std::string getFacet (gsoap_resqml2_0_1::resqml20__Facet facet) const
 
gsoap_resqml2_0_1::resqml20__Facet getFacet (const std::string &facet) const
 
std::string lengthUomToString (gsoap_eml2_1::eml21__LengthUom witsmlUom) const
 
std::string verticalCoordinateUomToString (gsoap_eml2_1::eml21__VerticalCoordinateUom witsmlUom) const
 
std::string planeAngleUomToString (gsoap_eml2_1::eml21__PlaneAngleUom witsmlUom) const
 

Detailed Description

A class for mapping enum values with strings.

Constructor & Destructor Documentation

◆ EnumStringMapper()

common::EnumStringMapper::EnumStringMapper ( )

Default constructor

◆ ~EnumStringMapper()

common::EnumStringMapper::~EnumStringMapper ( )

Destructor

Member Function Documentation

◆ getEnergisticsPropertyKind()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind common::EnumStringMapper::getEnergisticsPropertyKind ( const std::string &  energisticsPropertyKindName) const

Get the RESQML2.0 property kind enumerated value from the name of a property kind

Parameters
energisticsPropertyKindNameThe name of a RESQML2.0 property kind.
Returns
The RESQML2.0 property kind enumerated value corresponding to energisticsPropertyKindName if successful. The most abstract RESQML2.0 property kind enumerated value if no correspondence is found.

◆ getEnergisticsPropertyKindName()

std::string common::EnumStringMapper::getEnergisticsPropertyKindName ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  energisticsPropertyKind) const

Get the name of a RESQML2.0 property kind as a string based on the property kind enumerated value

Parameters
energisticsPropertyKindA RESQML2.0 property kind.
Returns
A string corresponding to energisticsPropertyKind if successful. The empty string if no correspondence is found.

◆ getEnergisticsUnitOfMeasure()

gsoap_resqml2_0_1::resqml20__ResqmlUom common::EnumStringMapper::getEnergisticsUnitOfMeasure ( const std::string &  energisticsUomName) const

Get the RESQML2.0 unit of measure enumerated value from the name of a unit of measure

Parameters
energisticsUomNameThe name of a RESQML2.0 unit of measure.
Returns
The RESQML2.0 unit of measure enumerated value corresponding to energisticsUomName if successful. The Euclidian (no unit of measure) RESQML2.0 unit of measure if no correspondence is found.

◆ getEnergisticsUnitOfMeasureName()

std::string common::EnumStringMapper::getEnergisticsUnitOfMeasureName ( gsoap_resqml2_0_1::resqml20__ResqmlUom  energisticsUom) const

Get the name of a RESQML2.0 unit of measure as a string based on the unit of measure enumerated value

Parameters
energisticsUomA RESQML2.0 unit of measure.
Returns
A string corresponding to energisticsUom if successful. The empty string if no correspondence is found.

◆ getFacet() [1/2]

gsoap_resqml2_0_1::resqml20__Facet common::EnumStringMapper::getFacet ( const std::string &  facet) const

Get the RESQML2.0 facet enumerated value from the name of a facet.

Parameters
facetThe name of a RESQML2.0 facet.
Returns
The RESQML2.0 facet enumerated value corresponding to facet if successful. The what facet enumerated value if no correspendance is found.

◆ getFacet() [2/2]

std::string common::EnumStringMapper::getFacet ( gsoap_resqml2_0_1::resqml20__Facet  facet) const

Get the name of a RESQML2.0 facet as a string based on the enumerated facet enumerated value

Parameters
facetA RESQML2.0 facet.
Returns
A string corresponding to facet if successful. The empty string if no correspondence is found.

◆ lengthUomToString()

std::string common::EnumStringMapper::lengthUomToString ( gsoap_eml2_1::eml21__LengthUom  witsmlUom) const

Get the name of an EML2.1 length unit of measure as a string based on the unit of measure enumerated value

Parameters
witsmlUomAn EML2.1 length unit of measure.
Returns
A string corresponding to witsmlUom if successful. The empty string if no correspondence is found.

◆ planeAngleUomToString()

std::string common::EnumStringMapper::planeAngleUomToString ( gsoap_eml2_1::eml21__PlaneAngleUom  witsmlUom) const

Get the name of an EML2.1 plane angle unit of measure as a string based on the unit of measure enumerated value

Parameters
witsmlUomAn EML2.1 plane angle unit of measure.
Returns
A string corresponding to witsmlUom if successful. The empty string if no correspondence is found.

◆ verticalCoordinateUomToString()

std::string common::EnumStringMapper::verticalCoordinateUomToString ( gsoap_eml2_1::eml21__VerticalCoordinateUom  witsmlUom) const

Get the name of an EML2.1 vertical coordinate unit of measure as a string based on the unit of measure enumerated value

Parameters
witsmlUomAn EML2.1 vertical coordinate unit of measure.
Returns
A string corresponding to witsmlUom if successful. The empty string if no correspondence is found.

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