Fesapi 2.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
resqml2_0_1::DoubleTableLookup Class Referencefinal

#include <DoubleTableLookup.h>

Inheritance diagram for resqml2_0_1::DoubleTableLookup:
resqml2::DoubleTableLookup common::AbstractObject

Public Member Functions

 DoubleTableLookup (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 DoubleTableLookup (common::DataObjectRepository *repo, const std::string &guid, const std::string &title)
 DoubleTableLookup (gsoap_resqml2_0_1::_resqml20__DoubleTableLookup *fromGsoap)
 ~DoubleTableLookup ()=default
bool containsKey (double key) final
uint64_t getItemCount () const final
double getKeyAtIndex (uint64_t index) const final
double getValueAtIndex (uint64_t index) const final
double getValueAtKey (double key) final
void addValue (double key, double longValue) final
void setValue (double key, double longValue) final
double getMinimumValue () final
double getMaximumValue () final
std::map< double, double > getMap () const final
std::string getXmlNamespace () const final
Public Member Functions inherited from resqml2::DoubleTableLookup
 DoubleTableLookup (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
std::string getXmlTag () const 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::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)
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::ActivitygetActivity (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
uint64_t getExtraMetadataCount () const
std::string getExtraMetadataKeyAtIndex (uint64_t index) const
std::string getExtraMetadataStringValueAtIndex (uint64_t 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_NS = "resqml20"
Static Public Attributes inherited from resqml2::DoubleTableLookup
static constexpr char const * XML_TAG = "DoubleTableLookup"

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 double table lookup.

Constructor & Destructor Documentation

◆ DoubleTableLookup() [1/3]

resqml2_0_1::DoubleTableLookup::DoubleTableLookup ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context

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

◆ DoubleTableLookup() [2/3]

resqml2_0_1::DoubleTableLookup::DoubleTableLookup ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title )

Creates an instance of this class in a gsoap context.

Parameters
[in,out]repoA repo which will manage the memory of this instance.
guidThe guid to set to this instance. If empty then a new guid will be generated.
titleA title for the instance to create.

◆ DoubleTableLookup() [3/3]

resqml2_0_1::DoubleTableLookup::DoubleTableLookup ( gsoap_resqml2_0_1::_resqml20__DoubleTableLookup * fromGsoap)
inline

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

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

◆ ~DoubleTableLookup()

resqml2_0_1::DoubleTableLookup::~DoubleTableLookup ( )
virtualdefault

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

Reimplemented from resqml2::DoubleTableLookup.

Member Function Documentation

◆ addValue()

void resqml2_0_1::DoubleTableLookup::addValue ( double key,
double value )
finalvirtual

Adds a key/value pair to this double table lookup. No verification that the key already exists is done.

Parameters
keyA key.
valueTeh associated value.

Implements resqml2::DoubleTableLookup.

◆ containsKey()

bool resqml2_0_1::DoubleTableLookup::containsKey ( double key)
finalvirtual

Checks whether a key is contained within this double table lookup.

Parameters
keyA key.
Returns
True if key is a key of this double table lookup, false if not.

Implements resqml2::DoubleTableLookup.

◆ getItemCount()

uint64_t resqml2_0_1::DoubleTableLookup::getItemCount ( ) const
finalvirtual

Gets the count of items in the double table lookup (in its map).

Returns
The count of items.

Implements resqml2::DoubleTableLookup.

◆ getKeyAtIndex()

double resqml2_0_1::DoubleTableLookup::getKeyAtIndex ( uint64_t index) const
finalvirtual

Gets the key of a key/value pair at a particular index of this double table lookup (in its map).

Exceptions
std::out_of_rangeIf index >= getItemCount().
Parameters
indexZero-based index of the key/value pair.
Returns
The key of the key/value pair at position index.

Implements resqml2::DoubleTableLookup.

◆ getMap()

std::map< double, double > resqml2_0_1::DoubleTableLookup::getMap ( ) const
finalvirtual

Build and return a key/value map of this double table lookup. You cannot use this map to set a value since it is built at each call.

Returns
The key/value map.

Implements resqml2::DoubleTableLookup.

◆ getMaximumValue()

double resqml2_0_1::DoubleTableLookup::getMaximumValue ( )
finalvirtual

Gets the maximum key in this double table lookup. It reads it from file.

Returns
The maximum key if some key/value pairs exists in this double table lookup, otherwise the double lowest value.

Implements resqml2::DoubleTableLookup.

◆ getMinimumValue()

double resqml2_0_1::DoubleTableLookup::getMinimumValue ( )
finalvirtual

Gets the minimum key in this double table lookup. It reads it from file.

Returns
The minimum key if some key/value pairs exists in this double table lookup, otherwise the double maximum value.

Implements resqml2::DoubleTableLookup.

◆ getValueAtIndex()

double resqml2_0_1::DoubleTableLookup::getValueAtIndex ( uint64_t index) const
finalvirtual

Gets the value of a key/value pair at a particular index of this double table lookup (in its map).

Exceptions
std::out_of_rangeIf index >= getItemCount().
Parameters
indexZero-based index of the key/value pair.
Returns
The value of the key/value pair at position index.

Implements resqml2::DoubleTableLookup.

◆ getValueAtKey()

double resqml2_0_1::DoubleTableLookup::getValueAtKey ( double key)
finalvirtual

Gets a value from its associated key.

Parameters
longValueA key.
Returns
The value corresponding to the key longValue if it exists, NaN if not.

Implements resqml2::DoubleTableLookup.

◆ getXmlNamespace()

std::string resqml2_0_1::DoubleTableLookup::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setValue()

void resqml2_0_1::DoubleTableLookup::setValue ( double key,
double value )
finalvirtual

Modifies the value associated to a key. If the key does not exist, nothing is done.

Parameters
keyA key.
valueTeh associated value.

Implements resqml2::DoubleTableLookup.

Member Data Documentation

◆ XML_NS

char const* resqml2_0_1::DoubleTableLookup::XML_NS = "resqml20"
staticconstexpr

The standard XML namespace for serializing this data object.


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