Defines a function for table lookups. For example, used for linear interpolation, such as PVT. More...

#include <DoubleTableLookup.h>

Inheritance diagram for resqml2::DoubleTableLookup:

Public Member Functions
	DoubleTableLookup (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

virtual	~DoubleTableLookup ()=default

virtual bool	containsKey (double key)=0

virtual unsigned int	getItemCount () const =0

virtual double	getKeyAtIndex (unsigned int index) const =0

virtual double	getValueAtIndex (unsigned int index) const =0

virtual double	getValueAtKey (double key)=0

virtual void	addValue (double key, double value)=0

virtual void	setValue (double key, double value)=0

virtual double	getMinimumValue ()=0

virtual double	getMaximumValue ()=0

virtual std::map< double, double >	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)

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::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)

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

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int 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_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

Defines a function for table lookups. For example, used for linear interpolation, such as PVT.

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

Constructor & Destructor Documentation

◆ DoubleTableLookup()

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

◆ ~DoubleTableLookup()

virtual resqml2::DoubleTableLookup::~DoubleTableLookup ( )

virtualdefault

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

Reimplemented in resqml2_0_1::DoubleTableLookup.

Member Function Documentation

◆ addValue()

virtual void resqml2::DoubleTableLookup::addValue	(	double	key,
		double	value )

pure virtual

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

Parameters

key	A key.
value	Teh associated value.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ containsKey()

virtual bool resqml2::DoubleTableLookup::containsKey ( double key )

pure virtual

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

Parameters

key A key.

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

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getItemCount()

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

pure virtual

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

Returns: The count of items.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getKeyAtIndex()

virtual double resqml2::DoubleTableLookup::getKeyAtIndex ( unsigned int index ) const

pure virtual

Gets the key of a key/value pair at a particular index of this double 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_0_1::DoubleTableLookup.

◆ getMap()

virtual std::map< double, double > resqml2::DoubleTableLookup::getMap ( ) const

pure virtual

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.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getMaximumValue()

virtual double resqml2::DoubleTableLookup::getMaximumValue ( )

pure virtual

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.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getMinimumValue()

virtual double resqml2::DoubleTableLookup::getMinimumValue ( )

pure virtual

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.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getValueAtIndex()

virtual double resqml2::DoubleTableLookup::getValueAtIndex ( unsigned int index ) const

pure virtual

Gets the value of a key/value pair at a particular index of this double 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 value of the key/value pair at position index.

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getValueAtKey()

virtual double resqml2::DoubleTableLookup::getValueAtKey ( double key )

pure virtual

Gets a value from its associated key.

Parameters

longValue A key.

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

Implemented in resqml2_0_1::DoubleTableLookup.

◆ getXmlTag()

std::string resqml2::DoubleTableLookup::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::DoubleTableLookup::setValue	(	double	key,
		double	value )

pure virtual

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

Parameters

key	A key.
value	Teh associated value.

Implemented in resqml2_0_1::DoubleTableLookup.

Member Data Documentation

◆ XML_TAG

char const* resqml2::DoubleTableLookup::XML_TAG = "DoubleTableLookup"

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.10.1.0/src/resqml2/DoubleTableLookup.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DoubleTableLookup()

◆ ~DoubleTableLookup()

Member Function Documentation

◆ addValue()

◆ containsKey()

◆ getItemCount()

◆ getKeyAtIndex()

◆ getMap()

◆ getMaximumValue()

◆ getMinimumValue()

◆ getValueAtIndex()

◆ getValueAtKey()

◆ getXmlTag()

◆ setValue()

Member Data Documentation

◆ XML_TAG