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

Key lookup map and collection. More...

#include <KeyLookup.hh>

List of all members.

Public Types

typedefkey_type
typedef Map::mapped_type mapped_type
typedef Map::value_type value_type
typedef Map::reference reference
typedef Map::const_reference const_reference
typedef Map::size_type size_type
typedef Keys::const_iterator const_iterator
typedefKey
typedef Map::mapped_type Mapped
typedef Map::value_type Value
typedef Map::reference Reference
typedef Map::const_reference ConstReference
typedef Map::size_type Size
typedef Keys::const_iterator ConstIterator

Static Public Member Functions

static void add (Key const &key)
 Add a key.
static void add (Key const &key, std::string const &identifier)
 Add a key with an extra (non-unique) identifier.
template<typename KeyC >
static Key const & gen (std::string const &id)
 Key with an identifier: Generate key if not present.
template<typename KeyC >
static Key const & gen (std::string const &id, std::string const &identifier)
 Key with an identifier: Generate key if not present.
template<typename KeyC >
static Key const & gen (std::string const &id, std::string const &identifier, std::string const &code)
 Key with an identifier: Generate key if not present.
static void remove (Key const &key)
 Remove a key.
static void clear ()
 Clear the collection and lookup map.
static Size size ()
 Size.
static bool empty ()
 Empty?
static bool has (std::string const &id)
 Has a key with an identifier?
static bool has (Key const &key)
 Has a key?
static Key const & key (std::string const &id)
 Key with an identifier.
static Key::Size n_key ()
 Number of keys with distinct indexes.
static ConstIterator begin ()
 Begin const iterator.
static ConstIterator end ()
 End const iterator.

Detailed Description

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

Key lookup map and collection.


Member Typedef Documentation

template<typename K>
typedef Map::const_reference utility::keys::KeyLookup< K >::const_reference
template<typename K>
typedef Map::const_reference utility::keys::KeyLookup< K >::ConstReference
template<typename K>
typedef K utility::keys::KeyLookup< K >::Key
template<typename K>
typedef K utility::keys::KeyLookup< K >::key_type
template<typename K>
typedef Map::mapped_type utility::keys::KeyLookup< K >::Mapped
template<typename K>
typedef Map::mapped_type utility::keys::KeyLookup< K >::mapped_type
template<typename K>
typedef Map::reference utility::keys::KeyLookup< K >::reference
template<typename K>
typedef Map::reference utility::keys::KeyLookup< K >::Reference
template<typename K>
typedef Map::size_type utility::keys::KeyLookup< K >::Size
template<typename K>
typedef Map::size_type utility::keys::KeyLookup< K >::size_type
template<typename K>
typedef Map::value_type utility::keys::KeyLookup< K >::Value
template<typename K>
typedef Map::value_type utility::keys::KeyLookup< K >::value_type

Member Function Documentation

template<typename K>
static void utility::keys::KeyLookup< K >::add ( Key const &  key) [inline, static]
template<typename K>
static void utility::keys::KeyLookup< K >::add ( Key const &  key,
std::string const &  identifier 
) [inline, static]

Add a key with an extra (non-unique) identifier.

References assign_charges::first.

template<typename K>
static ConstIterator utility::keys::KeyLookup< K >::begin ( ) [inline, static]

Begin const iterator.

template<typename K>
static void utility::keys::KeyLookup< K >::clear ( ) [inline, static]

Clear the collection and lookup map.

template<typename K>
static bool utility::keys::KeyLookup< K >::empty ( ) [inline, static]

Empty?

template<typename K>
static ConstIterator utility::keys::KeyLookup< K >::end ( ) [inline, static]

End const iterator.

template<typename K>
template<typename KeyC >
static Key const& utility::keys::KeyLookup< K >::gen ( std::string const &  id,
std::string const &  identifier 
) [inline, static]

Key with an identifier: Generate key if not present.

References utility::keys::KeyLookup< K >::add(), color_pdb::i, and utility::keys::KeyLookup< K >::key().

template<typename K>
template<typename KeyC >
static Key const& utility::keys::KeyLookup< K >::gen ( std::string const &  id,
std::string const &  identifier,
std::string const &  code 
) [inline, static]

Key with an identifier: Generate key if not present.

References utility::keys::KeyLookup< K >::add(), color_pdb::i, and utility::keys::KeyLookup< K >::key().

template<typename K>
template<typename KeyC >
static Key const& utility::keys::KeyLookup< K >::gen ( std::string const &  id) [inline, static]

Key with an identifier: Generate key if not present.

References utility::keys::KeyLookup< K >::add(), color_pdb::i, and utility::keys::KeyLookup< K >::key().

template<typename K>
static bool utility::keys::KeyLookup< K >::has ( Key const &  key) [inline, static]

Has a key?

template<typename K>
static bool utility::keys::KeyLookup< K >::has ( std::string const &  id) [inline, static]

Has a key with an identifier?

template<typename K>
static Key const& utility::keys::KeyLookup< K >::key ( std::string const &  id) [inline, static]
template<typename K>
static Key::Size utility::keys::KeyLookup< K >::n_key ( ) [inline, static]

Number of keys with distinct indexes.

template<typename K>
static void utility::keys::KeyLookup< K >::remove ( Key const &  key) [inline, static]

Remove a key.

References color_pdb::i, and utility::keys::KeyLookup< K >::key().

template<typename K>
static Size utility::keys::KeyLookup< K >::size ( ) [inline, static]

Size.


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