Teuchos - Trilinos Tools Package Version of the Day
Teuchos_SimpleObjectTable.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #include "Teuchos_Array.hpp"
00043 #include "Teuchos_RCP.hpp"
00044 
00045 #ifndef TEUCHOS_SIMPLEOBJECTTABLE_HPP
00046 #define TEUCHOS_SIMPLEOBJECTTABLE_HPP
00047 
00056 namespace Teuchos
00057 {
00058 
00059 template <class T>
00060 class SimpleObjectTable
00061 {
00062   public:
00063 
00064     SimpleObjectTable();
00065 
00066     ~SimpleObjectTable();
00067 
00068     int storeRCP(const RCP<T> & robj);
00069 
00070     int storeNew(T* obj, bool owned = true);
00071 
00072     template <class TOld>
00073     int storeCastedRCP(const RCP<TOld> & robj_old);
00074 
00075     int removeRCP(int &index);
00076 
00077     const RCP<T> getRCP(int index);
00078 
00079     void purge();
00080 
00081   private:
00082 
00083     Array< RCP<T> > tableOfObjects;
00084 
00085     Array< int > freedIndices;
00086 
00087 };
00088 
00089 template <class T>
00090 SimpleObjectTable<T>::SimpleObjectTable()
00091 {
00092 
00093 }
00094 
00095 template <class T>
00096 SimpleObjectTable<T>::~SimpleObjectTable()
00097 {
00098   purge();
00099 }
00100 
00101 template <class T>
00102 int SimpleObjectTable<T>::storeRCP(const RCP<T> & robj)
00103 {
00104   robj.assert_not_null();
00105 
00106   int index = -1;
00107 
00108   if (freedIndices.size() != 0) {
00109     index = freedIndices.back();
00110     freedIndices.pop_back();
00111     tableOfObjects[index] = robj;
00112   } else {
00113     tableOfObjects.push_back(robj);
00114     index = tableOfObjects.size() - 1;
00115   }
00116 
00117   return index;
00118 }
00119 
00120 template <class T>
00121 int SimpleObjectTable<T>::storeNew(T* obj, bool owned)
00122 {
00123   return storeRCP(rcp(obj, owned));
00124 }
00125 
00126 template <class T>
00127 template <class TOld>
00128 int SimpleObjectTable<T>::storeCastedRCP(const RCP<TOld> & robj_old)
00129 {
00130   return storeRCP(rcp_dynamic_cast<T>(robj_old, true));
00131 }
00132 
00133 template <class T>
00134 int SimpleObjectTable<T>::removeRCP(int &index)
00135 {
00136   if (tableOfObjects[index] == Teuchos::null) {
00137     throw RangeError("Item has already been deleted from SimpleObjectTable.");
00138   }
00139 
00140   int cnt = tableOfObjects[index].count();
00141 
00142   tableOfObjects[index] = Teuchos::null;
00143   freedIndices.push_back(index);
00144   index = -1;
00145 
00146   return (cnt-1);
00147 }
00148 
00149 template <class T>
00150 const RCP<T> SimpleObjectTable<T>::getRCP(int index)
00151 {
00152   if (tableOfObjects[index] == Teuchos::null) {
00153     throw RangeError("Item has already been deleted from SimpleObjectTable.");
00154   }
00155 
00156   return tableOfObjects[index];
00157 }
00158 
00159 template <class T>
00160 void SimpleObjectTable<T>::purge()
00161 {
00162   int ocnt = tableOfObjects.size();
00163   for (int i=0; i<ocnt; i++) {
00164     tableOfObjects[i] = Teuchos::null;
00165   }
00166 
00167   if (tableOfObjects.size() > 0)
00168     tableOfObjects.erase(tableOfObjects.begin(), tableOfObjects.end());
00169   if (freedIndices.size() > 0)
00170     freedIndices.erase(freedIndices.begin(), freedIndices.end());
00171 }
00172 
00173 } // end namespace Teuchos
00174 
00175 #endif
00176 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines