CObjectHistory.hpp

/* This file is part of sutil, a random collection of utilities.

sutil 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 3 of the License, or (at your option) any later version.

Alternatively, you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.

sutil 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 General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License and a copy of the GNU General Public License along with
sutil. If not, see <http://www.gnu.org/licenses/>.
 */
/* \file  CObjectHistory.hpp
 *
 *  Created on: Nov 18, 2011
 *
 *  Copyright (C) 2011, Samir Menon <smenon@stanford.edu>
 */

#ifndef COBJECTHISTORY_HPP_
#define COBJECTHISTORY_HPP_

#include <sutil/CMappedList.hpp>
#include <sutil/CSystemClock.hpp>

#ifdef DEBUG
#include <iostream>
#endif

namespace sutil
{
  template<typename Idx, typename StoreObjectsAs /* = Idx //works best */>
  class CObjectHistory
  {
  protected:
    CMappedList<
      Idx,
      CMappedList<double, StoreObjectsAs>
    > data_;

  public:
    bool saveObject(const Idx& arg_idx, const StoreObjectsAs& arg_obj)
    {
      bool flag;
      CMappedList<double, StoreObjectsAs>* objl = data_.at(arg_idx);
      if(NULL == objl)
      {
        flag = data_.create(arg_idx);
        if(false == flag)
        {
#ifdef DEBUG
          std::cerr<<"\nCObjectHistory::addObject() : Could not create an entry for this object";
#endif
          return false;
        }
        objl = data_.at(arg_idx);
        if(NULL == objl)
        {
#ifdef DEBUG
          std::cerr<<"\nCObjectHistory::addObject() : Created an entry for this object but can't access it. Invalid state.";
#endif
          return false;
        }
      }

      flag = objl->create(CSystemClock::getSysTime(), arg_obj);//Stores objects at the start
      if(false == flag)
      {
#ifdef DEBUG
        std::cerr<<"\nCObjectHistory::addObject() : Could not timestamp and store this object";
#endif
        return false;
      }

      return true;
    }

    const CMappedList<double, StoreObjectsAs>*
    getObjectTimeSeries(const Idx& arg_idx)
    { return data_.at(arg_idx); }

    const StoreObjectsAs* getObject(const Idx& arg_idx,
        double arg_time = -1.0)
    {
      CMappedList<double, StoreObjectsAs>* objl = data_.at(arg_idx);
      if(NULL == objl)
      {
#ifdef DEBUG
        std::cerr<<"\nCObjectHistory::getObject() : Can't find object in history.";
#endif
        return NULL;
      }
      //Now check for the time
      if(arg_time > 0.0)
      { return objl->at(arg_time); }
      else
      { return objl->at( std::size_t(0) );  }
    }

    bool removeObjectTimeSeries(const Idx& arg_idx)
    { return data_.erase(arg_idx); }

    bool removeObject(const Idx& arg_idx,
        double arg_time = -1)
    {
      CMappedList<double, StoreObjectsAs>* objl = data_.at(arg_idx);
      if(NULL == objl)
      {
#ifdef DEBUG
        std::cerr<<"\nCObjectHistory::removeObject() : Can't find object in history.";
#endif
        return NULL;
      }
      //Now check for the time
      if(arg_time > 0.0)
      { return objl->erase(arg_time); }
      else
      { return objl->erase( objl->at(std::size_t(0)) );  }
    }

    CObjectHistory(){}

    ~CObjectHistory(){}
  };

} /* namespace sutil */
#endif /* COBJECTHISTORY_HPP_ */