Rosetta 3.3
Public Types | Public Member Functions | Friends
utility::keys::VariantKey< K > Class Template Reference

Variant key class. More...

#include <VariantKey.hh>

Collaboration diagram for utility::keys::VariantKey< K >:
Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

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

Friends

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

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 ( ) [inline]

Destructor.


Member Function Documentation

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

Code.

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

Code.

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

Code assignment.

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

ID.

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

ID.

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

ID assignment.

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

Identifier.

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

Identifier assignment.

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

Identifier.

template<typename K >
utility::keys::VariantKey< K >::operator Key & ( ) [inline]

Key conversion.

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

Key conversion.

template<typename K >
Key& utility::keys::VariantKey< K >::operator() ( ) [inline]

Key.

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

Key.

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

Copy assignment.

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!

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]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines