Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
utility::keys::VariantKey< K > Class Template Reference

Variant key class. More...

#include <VariantKey.hh>

Public Types

typedefkey_type
 
typedef K::index_type index_type
 
typedefKey
 
typedef K::Index Index
 

Public Member Functions

 VariantKey ()
 Default constructor. More...
 
 VariantKey (VariantKey const &var)
 Copy constructor. More...
 
 VariantKey (Key const &key_a)
 Key constructor. More...
 
 ~VariantKey () throw ()
 Destructor. More...
 
VariantKeyoperator= (VariantKey const &var)
 Copy assignment. More...
 
 operator Key const & () const
 Key conversion. More...
 
 operator Key & ()
 Key conversion. More...
 
std::string const & id () const
 ID. More...
 
std::string & id ()
 ID. More...
 
VariantKeyid (std::string const &id_a)
 ID assignment. More...
 
std::string const & identifier () const
 Identifier. More...
 
std::string & identifier ()
 Identifier. More...
 
VariantKeyidentifier (std::string const &identifier_a)
 Identifier assignment. More...
 
std::string const & code () const
 Code. More...
 
std::string & code ()
 Code. More...
 
VariantKeycode (std::string const &code_a)
 Code assignment. More...
 
Index private_index () const
 Index. More...
 
Key const & operator() () const
 Key. More...
 
Keyoperator() ()
 Key. More...
 

Private Attributes

Keykey_p_
 Pointer to key. More...
 

Friends

bool operator== (VariantKey const &a, VariantKey const &b)
 VariantKey == VariantKey. More...
 
bool operator!= (VariantKey const &a, VariantKey const &b)
 VariantKey != VariantKey. More...
 
bool operator< (VariantKey const &a, VariantKey const &b)
 VariantKey < VariantKey. More...
 

Detailed Description

template<typename K>
class utility::keys::VariantKey< K >

Variant key class.

Member Typedef Documentation

template<typename K >
typedef K::Index utility::keys::VariantKey< K >::Index
template<typename K >
typedef K::index_type utility::keys::VariantKey< K >::index_type
template<typename K >
typedef K utility::keys::VariantKey< K >::Key
template<typename K >
typedef K utility::keys::VariantKey< K >::key_type

Constructor & Destructor Documentation

template<typename K >
utility::keys::VariantKey< K >::VariantKey ( )
inline

Default constructor.

template<typename K >
utility::keys::VariantKey< K >::VariantKey ( VariantKey< K > const &  var)
inline

Copy constructor.

template<typename K >
utility::keys::VariantKey< K >::VariantKey ( Key const &  key_a)
inline

Key constructor.

template<typename K >
utility::keys::VariantKey< K >::~VariantKey ( )
throw (
)
inline

Destructor.

References utility::keys::VariantKey< K >::key_p_.

Member Function Documentation

template<typename K >
std::string const& utility::keys::VariantKey< K >::code ( ) const
inline
template<typename K >
std::string& utility::keys::VariantKey< K >::code ( )
inline
template<typename K >
VariantKey& utility::keys::VariantKey< K >::code ( std::string const &  code_a)
inline

Code assignment.

References debug_assert, and utility::keys::VariantKey< K >::key_p_.

template<typename K >
std::string const& utility::keys::VariantKey< K >::id ( ) const
inline
template<typename K >
std::string& utility::keys::VariantKey< K >::id ( )
inline
template<typename K >
VariantKey& utility::keys::VariantKey< K >::id ( std::string const &  id_a)
inline

ID assignment.

References debug_assert, and utility::keys::VariantKey< K >::key_p_.

template<typename K >
std::string const& utility::keys::VariantKey< K >::identifier ( ) const
inline
template<typename K >
std::string& utility::keys::VariantKey< K >::identifier ( )
inline
template<typename K >
VariantKey& utility::keys::VariantKey< K >::identifier ( std::string const &  identifier_a)
inline

Identifier assignment.

References debug_assert, and utility::keys::VariantKey< K >::key_p_.

template<typename K >
utility::keys::VariantKey< K >::operator Key & ( )
inline
template<typename K >
utility::keys::VariantKey< K >::operator Key const & ( ) const
inline
template<typename K >
Key const& utility::keys::VariantKey< K >::operator() ( ) const
inline
template<typename K >
Key& utility::keys::VariantKey< K >::operator() ( )
inline
template<typename K >
VariantKey& utility::keys::VariantKey< K >::operator= ( VariantKey< K > const &  var)
inline

Copy assignment.

References utility::keys::VariantKey< K >::key_p_.

template<typename K >
Index utility::keys::VariantKey< K >::private_index ( ) const
inline

Index.

Note
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

References debug_assert, and utility::keys::VariantKey< K >::key_p_.

Friends And Related Function Documentation

template<typename K >
bool operator!= ( VariantKey< K > const &  a,
VariantKey< K > const &  b 
)
friend
template<typename K >
bool operator< ( VariantKey< K > const &  a,
VariantKey< K > const &  b 
)
friend
template<typename K >
bool operator== ( VariantKey< K > const &  a,
VariantKey< K > const &  b 
)
friend

Member Data Documentation

template<typename K >
Key* utility::keys::VariantKey< K >::key_p_
private

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