The VariantMap class provides a map between string keys and variant values.
#include <avogadro/core/variantmap.h>
|
using | iterator = std::map<std::string, Variant>::iterator |
using | const_iterator = std::map<std::string, Variant>::const_iterator |
◆ VariantMap()
Creates a new variant map object.
◆ ~VariantMap()
Destroys the variant map.
◆ size()
Returns the size of the variant map.
◆ isEmpty()
Returns true
if the variant map is empty (i.e. size() == 0
).
◆ names()
std::vector< std::string > names |
( |
| ) |
const |
Returns the names of the entries in the map.
◆ setValue()
void setValue |
( |
const std::string & | name, |
|
|
const Variant & | v ) |
Sets the value of name
to v
.
◆ value()
Variant value |
( |
const std::string & | name | ) |
const |
Returns the value for name
. If name
is not found a null variant is returned.
◆ hasValue()
bool hasValue |
( |
const std::string & | name | ) |
const |
Returns true if the key exists in the map.
◆ clear()
◆ begin() [1/2]
Return an iterator pointing to the beginning of the map.
◆ begin() [2/2]
const_iterator begin |
( |
| ) |
const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ constBegin()
const_iterator constBegin |
( |
| ) |
const |
Return a const_iterator pointing to the beginning of the map.
◆ end() [1/2]
Return an iterator pointing to the end of the map.
◆ end() [2/2]
const_iterator end |
( |
| ) |
const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ constEnd()
const_iterator constEnd |
( |
| ) |
const |
Return a const_iterator pointing to the end of the map.
The documentation for this class was generated from the following file: