Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_SimpleObjectTable.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#include "Teuchos_Array.hpp"
43#include "Teuchos_RCP.hpp"
44
45#ifndef TEUCHOS_SIMPLEOBJECTTABLE_HPP
46#define TEUCHOS_SIMPLEOBJECTTABLE_HPP
47
56namespace Teuchos
57{
58
59template <class T>
61{
62 public:
63
65
67
68 int storeRCP(const RCP<T> & robj);
69
70 int storeNew(T* obj, bool owned = true);
71
72 template <class TOld>
73 int storeCastedRCP(const RCP<TOld> & robj_old);
74
75 int removeRCP(int &index);
76
77 const RCP<T> getRCP(int index);
78
79 void purge();
80
81 private:
82
83 Array< RCP<T> > tableOfObjects;
84
85 Array< int > freedIndices;
86
87};
88
89template <class T>
91{
92
93}
94
95template <class T>
96SimpleObjectTable<T>::~SimpleObjectTable()
97{
98 purge();
99}
100
101template <class T>
102int SimpleObjectTable<T>::storeRCP(const RCP<T> & robj)
103{
104 robj.assert_not_null();
105
106 int index = -1;
107
108 if (freedIndices.size() != 0) {
109 index = freedIndices.back();
110 freedIndices.pop_back();
111 tableOfObjects[index] = robj;
112 } else {
113 tableOfObjects.push_back(robj);
114 index = tableOfObjects.size() - 1;
115 }
116
117 return index;
118}
119
120template <class T>
121int SimpleObjectTable<T>::storeNew(T* obj, bool owned)
122{
123 return storeRCP(rcp(obj, owned));
124}
125
126template <class T>
127template <class TOld>
128int SimpleObjectTable<T>::storeCastedRCP(const RCP<TOld> & robj_old)
129{
130 return storeRCP(rcp_dynamic_cast<T>(robj_old, true));
131}
132
133template <class T>
134int SimpleObjectTable<T>::removeRCP(int &index)
135{
136 if (tableOfObjects[index] == Teuchos::null) {
137 throw RangeError("Item has already been deleted from SimpleObjectTable.");
138 }
139
140 int cnt = tableOfObjects[index].strong_count();
141
142 tableOfObjects[index] = Teuchos::null;
143 freedIndices.push_back(index);
144 index = -1;
145
146 return (cnt-1);
147}
148
149template <class T>
150const RCP<T> SimpleObjectTable<T>::getRCP(int index)
151{
152 if (tableOfObjects[index] == Teuchos::null) {
153 throw RangeError("Item has already been deleted from SimpleObjectTable.");
154 }
155
156 return tableOfObjects[index];
157}
158
159template <class T>
160void SimpleObjectTable<T>::purge()
161{
162 int ocnt = tableOfObjects.size();
163 for (int i=0; i<ocnt; i++) {
164 tableOfObjects[i] = Teuchos::null;
165 }
166
167 if (tableOfObjects.size() > 0)
168 tableOfObjects.erase(tableOfObjects.begin(), tableOfObjects.end());
169 if (freedIndices.size() > 0)
170 freedIndices.erase(freedIndices.begin(), freedIndices.end());
171}
172
173} // end namespace Teuchos
174
175#endif
176
Templated array class derived from the STL std::vector.
Reference-counted pointer class and non-member templated function implementations.
Smart reference counting pointer class for automatic garbage collection.
RCP(ENull null_arg=null)
Initialize RCP<T> to NULL.
RCP< T > rcp(const boost::shared_ptr< T > &sptr)
Conversion function that takes in a boost::shared_ptr object and spits out a Teuchos::RCP object.
This class provides a central place to store objects.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...