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 | Static Public Attributes | List of all members
resqml2_2::StringTableLookup Class Referencefinal

#include <StringTableLookup.h>

Inheritance diagram for resqml2_2::StringTableLookup:
resqml2::StringTableLookup common::AbstractObject

Public Member Functions

 StringTableLookup (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 StringTableLookup (common::DataObjectRepository *repo, const std::string &guid, const std::string &title)
 
 StringTableLookup (gsoap_eml2_3::_resqml22__StringTableLookup *fromGsoap)
 
 ~StringTableLookup ()=default
 
bool containsKey (long longValue) final
 
unsigned int getItemCount () const final
 
long getKeyAtIndex (unsigned int index) const final
 
std::string getStringValueAtIndex (unsigned int index) const final
 
std::string getStringValue (long longValue) final
 
void addValue (const std::string &strValue, long longValue) final
 
void setValue (const std::string &strValue, long longValue) final
 
int64_t getMinimumValue () final
 
int64_t getMaximumValue () final
 
std::unordered_map< long, std::string > getMap () const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::StringTableLookup
 StringTableLookup (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)
 
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::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)
 
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::ActivitygetActivity (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_NS
 
- Static Public Attributes inherited from resqml2::StringTableLookup
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

A string table lookup.

Constructor & Destructor Documentation

◆ StringTableLookup() [1/3]

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

◆ StringTableLookup() [2/3]

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

◆ StringTableLookup() [3/3]

resqml2_2::StringTableLookup::StringTableLookup ( gsoap_eml2_3::_resqml22__StringTableLookup *  fromGsoap)
inline

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

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

◆ ~StringTableLookup()

resqml2_2::StringTableLookup::~StringTableLookup ( )
virtualdefault

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

Reimplemented from resqml2::StringTableLookup.

Member Function Documentation

◆ addValue()

void resqml2_2::StringTableLookup::addValue ( const std::string &  strValue,
long  longValue 
)
finalvirtual

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

Parameters
strValueA string value.
longValueA key.

Implements resqml2::StringTableLookup.

◆ containsKey()

bool resqml2_2::StringTableLookup::containsKey ( long  longValue)
finalvirtual

Checks whether a key is contained within this string lookup.

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

Implements resqml2::StringTableLookup.

◆ getItemCount()

unsigned int resqml2_2::StringTableLookup::getItemCount ( ) const
finalvirtual

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

Returns
The count of items.

Implements resqml2::StringTableLookup.

◆ getKeyAtIndex()

long resqml2_2::StringTableLookup::getKeyAtIndex ( unsigned int  index) const
finalvirtual

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

◆ getMap()

std::unordered_map<long, std::string> resqml2_2::StringTableLookup::getMap ( ) const
finalvirtual

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

Returns
The key/value map.

Implements resqml2::StringTableLookup.

◆ getMaximumValue()

int64_t resqml2_2::StringTableLookup::getMaximumValue ( )
finalvirtual

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.

Implements resqml2::StringTableLookup.

◆ getMinimumValue()

int64_t resqml2_2::StringTableLookup::getMinimumValue ( )
finalvirtual

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.

Implements resqml2::StringTableLookup.

◆ getStringValue()

std::string resqml2_2::StringTableLookup::getStringValue ( long  longValue)
finalvirtual

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

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

Implements resqml2::StringTableLookup.

◆ getStringValueAtIndex()

std::string resqml2_2::StringTableLookup::getStringValueAtIndex ( unsigned int  index) const
finalvirtual

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_rangeIf index >= getItemCount().
Parameters
indexZero-based index of the key/value pair.
Returns
The string value of the key/value pair at position index.

Implements resqml2::StringTableLookup.

◆ getXmlNamespace()

std::string resqml2_2::StringTableLookup::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setValue()

void resqml2_2::StringTableLookup::setValue ( const std::string &  strValue,
long  longValue 
)
finalvirtual

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

Parameters
strValueThe new string value.
longValueA key.

Implements resqml2::StringTableLookup.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::StringTableLookup::XML_NS
static

The standard XML namespace for serializing this data object.


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