Teuchos_SimpleObjectTable.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"

#ifndef TEUCHOS_SIMPLEOBJECTTABLE_HPP
#define TEUCHOS_SIMPLEOBJECTTABLE_HPP

namespace Teuchos
{

template <class T>
class SimpleObjectTable
{
  public:

    SimpleObjectTable();

    ~SimpleObjectTable();

    int storeRCP(const RCP<T> & robj);

    int storeNew(T* obj, bool owned = true);

    template <class TOld>
    int storeCastedRCP(const RCP<TOld> & robj_old);

    int removeRCP(int &index);

    const RCP<T> getRCP(int index);

    void purge();

  private:

    Array< RCP<T> > tableOfObjects;

    Array< int > freedIndices;

};

template <class T>
SimpleObjectTable<T>::SimpleObjectTable()
{

}

template <class T>
SimpleObjectTable<T>::~SimpleObjectTable()
{
  purge();
}

template <class T>
int SimpleObjectTable<T>::storeRCP(const RCP<T> & robj)
{
  robj.assert_not_null();

  int index = -1;

  if (freedIndices.size() != 0) {
    index = freedIndices.back();
    freedIndices.pop_back();
    tableOfObjects[index] = robj;
  } else {
    tableOfObjects.push_back(robj);
    index = tableOfObjects.size() - 1;
  }

  return index;
}

template <class T>
int SimpleObjectTable<T>::storeNew(T* obj, bool owned)
{
  return storeRCP(rcp(obj, owned));
}

template <class T>
template <class TOld>
int SimpleObjectTable<T>::storeCastedRCP(const RCP<TOld> & robj_old)
{
  return storeRCP(rcp_dynamic_cast<T>(robj_old, true));
}

template <class T>
int SimpleObjectTable<T>::removeRCP(int &index)
{
  if (tableOfObjects[index] == Teuchos::null) {
    throw RangeError("Item has already been deleted from SimpleObjectTable.");
  }

  int cnt = tableOfObjects[index].count();

  tableOfObjects[index] = Teuchos::null;
  freedIndices.push_back(index);
  index = -1;

  return (cnt-1);
}

template <class T>
const RCP<T> SimpleObjectTable<T>::getRCP(int index)
{
  if (tableOfObjects[index] == Teuchos::null) {
    throw RangeError("Item has already been deleted from SimpleObjectTable.");
  }

  return tableOfObjects[index];
}

template <class T>
void SimpleObjectTable<T>::purge()
{
  int ocnt = tableOfObjects.size();
  for (int i=0; i<ocnt; i++) {
    tableOfObjects[i] = Teuchos::null;
  }

  if (tableOfObjects.size() > 0)
    tableOfObjects.erase(tableOfObjects.begin(), tableOfObjects.end());
  if (freedIndices.size() > 0)
    freedIndices.erase(freedIndices.begin(), freedIndices.end());
}

} // end namespace Teuchos

#endif