resqml2::StringTableLookup Class Reference

Defines an integer (key) to string (value) lookup table, for example, stores facies properties, where a facies index is associated with a facies name. More...

#include <StringTableLookup.h>

Inheritance diagram for resqml2::StringTableLookup:

Public Member Functions
	StringTableLookup (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
virtual	~StringTableLookup ()=default
virtual bool	containsKey (int64_t key)=0
virtual uint64_t	getItemCount () const =0
virtual int64_t	getKeyAtIndex (uint64_t index) const =0
virtual std::string	getStringValueAtIndex (uint64_t index) const =0
virtual std::string	getStringValue (int64_t key)=0
virtual void	addValue (const std::string &strValue, int64_t key)=0
virtual void	setValue (const std::string &strValue, int64_t key)=0
virtual int64_t	getMinimumValue ()=0
virtual int64_t	getMaximumValue ()=0
virtual std::unordered_map< int64_t, std::string >	getMap () const =0
std::string	getXmlTag () const final

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

Detailed Description

Defines an integer (key) to string (value) lookup table, for example, stores facies properties, where a facies index is associated with a facies name.

Used for categorical properties, which also may use a double table lookup.

Constructor & Destructor Documentation

StringTableLookup()

resqml2::StringTableLookup::StringTableLookup ( 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.

~StringTableLookup()

virtual resqml2::StringTableLookup::~StringTableLookup ( )

virtualdefault

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

Member Function Documentation

addValue()

virtual void resqml2::StringTableLookup::addValue ( const std::string & strValue, int64_t key )

pure virtual

Adds a key/value pair to this string table lookup. No verification that the key (or string value) already exists is done.

Parameters

strValue	A string value.
longValue	A key.

containsKey()

virtual bool resqml2::StringTableLookup::containsKey ( int64_t key )

pure virtual

Checks whether a key is contained within this string lookup.

Parameters

key

A key.

Returns

True if longValue is a key of this string table lookup, false if not.

getItemCount()

virtual uint64_t resqml2::StringTableLookup::getItemCount ( ) const

pure virtual

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

Returns

The count of items.

getKeyAtIndex()

virtual int64_t resqml2::StringTableLookup::getKeyAtIndex ( uint64_t index ) const

pure virtual

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

Exceptions

std::out_of_range

If index >= getItemCount().

Parameters

index

Zero-based index of the key/value pair.

Returns

The key of the key/value pair at position index.

getMap()

virtual std::unordered_map< int64_t, std::string > resqml2::StringTableLookup::getMap ( ) const

pure virtual

Gets the underlying key/value map of this string table lookup.

Returns

The key/value map.

getMaximumValue()

virtual int64_t resqml2::StringTableLookup::getMaximumValue ( )

pure virtual

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

Returns

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

getMinimumValue()

virtual int64_t resqml2::StringTableLookup::getMinimumValue ( )

pure virtual

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

Returns

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

getStringValue()

virtual std::string resqml2::StringTableLookup::getStringValue ( int64_t key )

pure virtual

Gets a string value from its associated key.

Parameters

key

A key.

Returns

The string value corresponding to the key longValue if it exists, empty string if not.

getStringValueAtIndex()

virtual std::string resqml2::StringTableLookup::getStringValueAtIndex ( uint64_t index ) const

pure virtual

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

Exceptions

std::out_of_range

If index >= getItemCount().

Parameters

index

Zero-based index of the key/value pair.

Returns

The string value of the key/value pair at position index.

setValue()

virtual void resqml2::StringTableLookup::setValue ( const std::string & strValue, int64_t key )

pure virtual

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

Parameters

strValue	The new string value.
longValue	A key.

Member Data Documentation

XML_TAG

constexpr char const* resqml2::StringTableLookup::XML_TAG = "StringTableLookup"

staticconstexpr

The standard XML tag without 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/StringTableLookup.h