C API Documentation
Public Member Functions | Protected Types | Protected Attributes | List of all members
rr::BasicDictionary Class Reference

This class is frozen, no new features Basic implementation of the Dictionary interface which uses a std unordered map to store the values. More...

#include <Dictionary.h>

Inheritance diagram for rr::BasicDictionary:
rr::Dictionary rr::LoadSBMLOptions rr::SimulateOptions

Public Member Functions

void setItem (const std::string &key, const rr::Variant &value) override
 
Variant getItem (const std::string &key) const override
 
bool hasKey (const std::string &key) const override
 
size_t deleteItem (const std::string &key) override
 
std::vector< std::string > getKeys () const override
 
 ~BasicDictionary () override=default
 
- Public Member Functions inherited from rr::Dictionary
virtual ~Dictionary ()
 

Protected Types

typedef cxx11_ns::unordered_map< std::string, VariantVariantMap
 

Protected Attributes

VariantMap items
 

Detailed Description

This class is frozen, no new features Basic implementation of the Dictionary interface which uses a std unordered map to store the values.

Constructor & Destructor Documentation

◆ ~BasicDictionary()

rr::BasicDictionary::~BasicDictionary ( )
overridedefault

Pure virtual interface, you should never have to delete an instance of this type directly.

Member Function Documentation

◆ deleteItem()

size_t rr::BasicDictionary::deleteItem ( const std::string &  key)
overridevirtual

remove a value

Implements rr::Dictionary.

Reimplemented in rr::LoadSBMLOptions.

◆ getItem()

Variant rr::BasicDictionary::getItem ( const std::string &  key) const
overridevirtual

gets an item from the internal unordered map.

Implements rr::Dictionary.

Reimplemented in rr::LoadSBMLOptions.

◆ getKeys()

std::vector<std::string> rr::BasicDictionary::getKeys ( ) const
overridevirtual

list of keys in this object.

Implements rr::Dictionary.

Reimplemented in rr::LoadSBMLOptions.

◆ hasKey()

bool rr::BasicDictionary::hasKey ( const std::string &  key) const
overridevirtual

is there a key matching this name.

@retruns true if this key exists, false otherwise.

Implements rr::Dictionary.

Reimplemented in rr::LoadSBMLOptions.

◆ setItem()

void rr::BasicDictionary::setItem ( const std::string &  key,
const rr::Variant value 
)
overridevirtual

sets an item in the internal unordered map.

Implements rr::Dictionary.

Reimplemented in rr::SimulateOptions, and rr::LoadSBMLOptions.


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