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 (long longValue)=0

virtual unsigned int	getItemCount () const =0

virtual long	getKeyAtIndex (unsigned int index) const =0

virtual std::string	getStringValueAtIndex (unsigned int index) const =0

virtual std::string	getStringValue (long longValue)=0

virtual void	addValue (const std::string &strValue, long longValue)=0

virtual void	setValue (const std::string &strValue, long longValue)=0

virtual int64_t	getMinimumValue ()=0

virtual int64_t	getMaximumValue ()=0

virtual std::unordered_map< long, std::string >	getMap () const =0

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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	getXmlNamespace () const =0

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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

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

unsigned int	getActivityCount () const

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

Static Public Attributes
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 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

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.

Reimplemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

Member Function Documentation

◆ addValue()

virtual void resqml2::StringTableLookup::addValue	(	const std::string &	strValue,
		long	longValue
	)

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.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ containsKey()

virtual bool resqml2::StringTableLookup::containsKey ( long longValue )

pure virtual

Checks whether a key is contained within this string lookup.

Parameters

longValue A key.

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

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getItemCount()

virtual unsigned int resqml2::StringTableLookup::getItemCount ( ) const

pure virtual

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

Returns: The count of items.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getKeyAtIndex()

virtual long resqml2::StringTableLookup::getKeyAtIndex ( unsigned int 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.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getMap()

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

pure virtual

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

Returns: The key/value map.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ 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 long minimum value.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ 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 long maximum value.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getStringValue()

virtual std::string resqml2::StringTableLookup::getStringValue ( long longValue )

pure virtual

Gets a string value from its associated key (long).

Parameters

longValue A key.

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

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getStringValueAtIndex()

virtual std::string resqml2::StringTableLookup::getStringValueAtIndex ( unsigned int 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.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

◆ getXmlTag()

std::string resqml2::StringTableLookup::getXmlTag ( ) const

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ setValue()

virtual void resqml2::StringTableLookup::setValue	(	const std::string &	strValue,
		long	longValue
	)

pure virtual

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

Parameters

strValue	The new string value.
longValue	A key.

Implemented in resqml2_2::StringTableLookup, and resqml2_0_1::StringTableLookup.

Member Data Documentation

◆ XML_TAG

const char* resqml2::StringTableLookup::XML_TAG

static

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.0.0.0/src/resqml2/StringTableLookup.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringTableLookup()

◆ ~StringTableLookup()

Member Function Documentation

◆ addValue()

◆ containsKey()

◆ getItemCount()

◆ getKeyAtIndex()

◆ getMap()

◆ getMaximumValue()

◆ getMinimumValue()

◆ getStringValue()

◆ getStringValueAtIndex()

◆ getXmlTag()

◆ setValue()

Member Data Documentation

◆ XML_TAG