iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
KeyTableImpl.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_DESIGN_DETAILS_KEYTABLEIMPL_H
37 #define INCLUDE_NRT_CORE_DESIGN_DETAILS_KEYTABLEIMPL_H
38 
40 
41 template <class KeyType>
42 class nrt::KeyTable<KeyType>::KeyNotFoundException : public nrt::exception::Exception
43 {
44  public:
45  KeyNotFoundException(KeyType const & key) throw()
46  try : nrt::exception::Exception("Invalid key"), itsKey(key) { } catch (...) { }
47 
48  virtual ~KeyNotFoundException() throw() { }
49 
50  KeyType itsKey;
51 };
52 
53 // ######################################################################
54 template<class ValueType, class KeyType> inline
56 { }
57 
58 // ######################################################################
59 template<class KeyType> inline
61 {
62  // Recycle an old key, or generate a new one
63  KeyType key;
64  if (itsRecycleBin.size()) { key = itsRecycleBin.front(); itsRecycleBin.pop(); }
65  else { key = itsMaxKey++; }
66 
67  // This new key now has one user:
68  itsUsers.insert(std::make_pair(key, 1));
69 
70  return key;
71 }
72 
73 // ######################################################################
74 template <class KeyType> inline
75 size_t nrt::KeyTable<KeyType>::users(KeyType const & key) const
76 {
77  auto itr = itsUsers.find(key);
78  if (itr == itsUsers.end()) return 0; else return itr->second;
79 }
80 
81 // ######################################################################
82 template <class KeyType>
83 size_t nrt::KeyTable<ValueType, KeyType>::remove(KeyType const & key)
84 {
85  auto itr = itsUsers.find(key); if (itr == itsUsers.end()) throw KeyNotFoundException(key);
86 
87  // decrement user count:
88  -- itr->second;
89 
90  // delete the key if count down to zero:
91  if (itr->second == 0) { itsRecycleBin.push(key); itsUsers.erase(itr); return 0; }
92  else return itr->second;
93 }
94 
95 // ######################################################################
96 template <class KeyType>
98 {
99  itsUsers.clear();
100  itsRecycleBin = std::queue<KeyType>();
101  itsMaxId = 0;
102 }
103 
104 #endif // INCLUDE_NRT_CORE_DESIGN_DETAILS_KEYTABLEIMPL_H