AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
Provides a generic key type for mixed-key associative arrays/dictionaries. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/inlet/VariantKey.hpp>
Public Member Functions | |
VariantKey (const int key) | |
Parameterized constructors for initializing the variant. More... | |
VariantKey (const std::string &key) | |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
VariantKey (std::string &&key) | |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
VariantKey (const char key[]) | |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
VariantKey & | operator= (const int key) |
Parameterized assignment operators for re-initializing the variant. More... | |
VariantKey & | operator= (const std::string &key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
VariantKey & | operator= (std::string &&key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
VariantKey & | operator= (const char key[]) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
operator int () const | |
Implicit conversion operators to make usage more convenient. More... | |
operator const std::string & () const | |
InletType | type () const |
Returns the type of the active member. More... | |
bool | operator== (const VariantKey &other) const |
Comparison operator, returns true iff the active types are the same and the corresponding active members compare equal. More... | |
Provides a generic key type for mixed-key associative arrays/dictionaries.
|
inline |
Parameterized constructors for initializing the variant.
[in] | key | The key to initialize with |
References axom::inlet::Integer.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
References axom::inlet::String.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
References axom::inlet::String.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
References axom::inlet::String.
VariantKey& axom::inlet::VariantKey::operator= | ( | const int | key | ) |
Parameterized assignment operators for re-initializing the variant.
[in] | key | The key to initialize with |
VariantKey& axom::inlet::VariantKey::operator= | ( | const std::string & | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VariantKey& axom::inlet::VariantKey::operator= | ( | std::string && | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VariantKey& axom::inlet::VariantKey::operator= | ( | const char | key[] | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
axom::inlet::VariantKey::operator int | ( | ) | const |
Implicit conversion operators to make usage more convenient.
axom::inlet::VariantKey::operator const std::string & | ( | ) | const |
InletType axom::inlet::VariantKey::type | ( | ) | const |
Returns the type of the active member.
bool axom::inlet::VariantKey::operator== | ( | const VariantKey & | other | ) | const |
Comparison operator, returns true iff the active types are the same and the corresponding active members compare equal.
References axom::inlet::Integer, and axom::inlet::String.