albaTimeMapUX.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaTimeMapUX
 Authors: Marco Petrone
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef __albaTimeMap_h
#define __albaTimeMap_h
//----------------------------------------------------------------------------
// includes :
//----------------------------------------------------------------------------
#include "albaObject.h"
#include "albaTimeStamped.h"
#include "albaSmartPointer.h"
#include "albaMTime.h"
#include "albaString.h"
#include <map>
#include <vector>
#include "albaTimeMap.h"
#include "albaIndent.h"
#include <math.h>
#include <assert.h>
 
//------------------------------------------------------------------------------
// Forward declarations
//------------------------------------------------------------------------------
typedef std::vector<albaTimeStamp> mmuTimeVector;
 
template <class T>
class ALBA_EXPORT albaTimeMap : public albaObject, public albaTimeStamped
{
public:
  typedef std::map<albaTimeStamp, albaAutoPointer<T> > TimeMap;
  typedef std::pair<albaTimeStamp, albaAutoPointer<T> > mmuTimePair;
 
  albaTimeMap();  
  virtual ~albaTimeMap();
 
  albaTimeMap(const albaTimeMap<T>&);  
  void operator=(const albaTimeMap<T>&);
 
  //albaAbstractTypeMacro(albaTimeMap<T>,albaObject);
 
  void SetItemTypeName(const char *tname) {m_ItemTypeName=tname;}
  const char *GetItemTypeName() {return m_ItemTypeName;}
  
  virtual void AppendItem(T *m);
 
  virtual void AppendAndSetItem(T *m);
 
  virtual void PrependItem(T *m);
 
  typename albaTimeMap<T>::TimeMap::iterator FindItem(T *m);
 
  virtual void InsertItem(T *m);
  
  virtual void RemoveItem(typename albaTimeMap<T>::TimeMap::iterator it);
 
  int RemoveItem(int idx);
 
  virtual void RemoveAllItems();
 
  albaTimeStamp GetItemTime(int idx);
 
  void GetTimeStamps(mmuTimeVector &kframes) const;
 
  int GetNumberOfItems() const {return m_TimeMap.size();};
  
  //albaTimeStamp GetTimeStamp() {return m_CurrentTime;}
  //void SetTimeStamp(albaTimeStamp t);
 
  void GetTimeBounds(albaTimeStamp tbounds[2]);
 
  void DeepCopy(albaTimeMap *vitem);
 
  bool Equals(albaTimeMap *vmat);
 
  typename albaTimeMap<T>::TimeMap::iterator FindNearestItem(albaTimeStamp t);
 
  typename albaTimeMap<T>::TimeMap::iterator FindItemBefore(albaTimeStamp t);
 
  typename albaTimeMap<T>::TimeMap::iterator FindItem(albaTimeStamp t);
 
  typename albaTimeMap<T>::TimeMap::iterator FindItemByIndex(int idx);
 
  albaID FindItemIndex(albaTimeStamp t);
 
  T *GetItem(albaTimeStamp t);
 
  T *GetNearestItem(albaTimeStamp t);
 
  T *GetItemBefore(albaTimeStamp t);
 
  T *GetItemByIndex(int idx);
 
  virtual void Print(std::ostream& os, const int tabs=0) const;
 
  typename albaTimeMap<T>::TimeMap::iterator Begin() {return m_TimeMap.begin();}
  typename albaTimeMap<T>::TimeMap::iterator End() {return m_TimeMap.end();}
  typename albaTimeMap<T>::TimeMap::iterator Last() {return --(m_TimeMap.end());}
 
protected:
  TimeMap         m_TimeMap;        
  albaString       m_ItemTypeName;   
};
 
 
//-----------------------------------------------------------------------
template <class T>
albaTimeMap<T>::albaTimeMap()
//-----------------------------------------------------------------------
{
}
 
//-----------------------------------------------------------------------
template <class T>
albaTimeMap<T>::~albaTimeMap()
//-----------------------------------------------------------------------
{
}
 
//-----------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::AppendAndSetItem(T *m)
//-----------------------------------------------------------------------
{
  assert(m);
  if (this->GetNumberOfItems()>0)
  {
    // Get last item
     assert(m_TimeMap.rbegin()->second);
    // append adding 1 to the last time 
    m->SetTimeStamp(m_TimeMap.rbegin()->first+1);
  }
  else
   {
    m->SetTimeStamp(0);
  }
  AppendItem(m);
}
 
//-----------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::AppendItem(T *m)
//-----------------------------------------------------------------------
{
   assert(m);
  if (!m_ItemTypeName.IsEmpty())
  {
    assert(m->IsA(m_ItemTypeName));
    if (!m->IsA(m_ItemTypeName))
    {
      albaErrorMacro("Unsupported Item type \""<<m->GetTypeName()<<"\", allowed type is \""<<m_ItemTypeName<<"\": cannot Append item!");
      return;
    }
  }
   m_TimeMap.insert(m_TimeMap.end(),mmuTimePair(m->GetTimeStamp(),m));
   Modified();
}
 
//-----------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::PrependItem(T *m)
//-----------------------------------------------------------------------
{
  assert(m);
  if (!m_ItemTypeName.IsEmpty())
  {
    assert(m->IsA(m_ItemTypeName));
    if (!m->IsA(m_ItemTypeName))
    {
      albaErrorMacro("Unsupported Item type \""<<m->GetTypeName()<<"\", allowed type is \""<<m_ItemTypeName<<"\": cannot Prepend item!");
      return;
    }
  }
  m_TimeMap.insert(m_TimeMap.begin(),mmuTimePair(m->GetTimeStamp(),m));
  Modified();
}
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::InsertItem(T *m)
//-------------------------------------------------------------------------
{
  assert(m);
  if (!m_ItemTypeName.IsEmpty())
  {
    assert(m->IsA(m_ItemTypeName));
    if (!m->IsA(m_ItemTypeName))
    {
      albaErrorMacro("Unsupported Item type \""<<m->GetTypeName()<<"\", allowed type is \""<<m_ItemTypeName<<"\": cannot Insert item!");
      return;
    }
  }
 
  m_TimeMap[m->GetTimeStamp()]=m;   
  Modified();
}
 
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::GetTimeBounds(albaTimeStamp tbounds[2])
//-------------------------------------------------------------------------
{
  // this is a sorted array
  if (m_TimeMap.size()>0)
  {
     tbounds[0]=m_TimeMap.begin()->first;
     tbounds[1]=m_TimeMap.rbegin()->first;
  }
  else
  {
     tbounds[0]=-1;
     tbounds[1]=-1;
  }
}
 
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::GetTimeStamps(mmuTimeVector &kframes) const
//-------------------------------------------------------------------------
{
  kframes.clear();
 
  for (typename albaTimeMap<T>::TimeMap::const_iterator it=m_TimeMap.begin();it!=m_TimeMap.end();it++)
  {
    kframes.push_back(it->first);
  }
}
 
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::DeepCopy(albaTimeMap *o)
//-------------------------------------------------------------------------
{
  RemoveAllItems();
  //m_TimeMap=o->m_TimeMap;
  typename albaTimeMap<T>::TimeMap::iterator it;
  for (it=o->Begin();it!=o->End();it++)
  {
    T *m=it->second;
    T *new_item=m->NewInstance();
    new_item->DeepCopy(m);
    AppendItem(new_item);
  }
  Modified();
}
 
//-------------------------------------------------------------------------
template <class T>
bool albaTimeMap<T>::Equals(albaTimeMap *o)
//-------------------------------------------------------------------------
{
  if (o==NULL)
    return false;
 
  if (GetNumberOfItems()!=o->GetNumberOfItems())
    return false;
 
  typename albaTimeMap<T>::TimeMap::iterator it;
  typename albaTimeMap<T>::TimeMap::iterator it2;
  for (it=m_TimeMap.begin(),it2=o->m_TimeMap.begin();it!=m_TimeMap.end();it++,it2++)
  {
    T *m=it->second;
    T *m2=it2->second;
 
    if (!m->Equals(m2))
      return false;
  }
 
  return true;
}
 
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::RemoveItem(typename albaTimeMap<T>::TimeMap::iterator it)
//-------------------------------------------------------------------------
{
  m_TimeMap.erase(it);
  Modified();
}
 
//-------------------------------------------------------------------------
template <class T>
int albaTimeMap<T>::RemoveItem(int idx)
//-------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindItemByIndex(idx);
  if (it!=m_TimeMap.end())
  {
    RemoveItem(it);
    return ALBA_OK;
  }
 
  return ALBA_ERROR;
}
 
//-------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::RemoveAllItems()
//-------------------------------------------------------------------------
{
  m_TimeMap.clear();
  Modified();
}
 
//-------------------------------------------------------------------------
template <class T>
typename albaTimeMap<T>::TimeMap::iterator albaTimeMap<T>::FindNearestItem(albaTimeStamp t)
//-------------------------------------------------------------------------
{
  std::pair<typename albaTimeMap<T>::TimeMap::iterator,typename albaTimeMap<T>::TimeMap::iterator> range=m_TimeMap.equal_range(t);
  if (range.first!=m_TimeMap.end())
  {
    if (range.second!=m_TimeMap.end())
    {
      if (fabs(range.first->first-t)>fabs(range.second->first-t))
         return range.second;
    }    
    return range.first;
  }
  else if (range.second!=m_TimeMap.end())
  {
    return range.second;
  }
 
  return --range.second;
}
 
 
//-------------------------------------------------------------------------
template <class T>
typename albaTimeMap<T>::TimeMap::iterator albaTimeMap<T>::FindItemBefore(albaTimeStamp t)
//-------------------------------------------------------------------------
{
  if (m_TimeMap.size()>0)
  {
    typename albaTimeMap<T>::TimeMap::iterator it=m_TimeMap.lower_bound(t); // find first item >= t
    if (it==m_TimeMap.end()||it!=m_TimeMap.begin()&&it->first>t) // if > t get the previous 
      --it;
 
    return it;
  }
  else
  {
    return m_TimeMap.end();
  }
  
}
 
 
//-------------------------------------------------------------------------
template <class T>
typename albaTimeMap<T>::TimeMap::iterator albaTimeMap<T>::FindItem(albaTimeStamp t)
//-------------------------------------------------------------------------
{
  return m_TimeMap.find(t);
}
 
//----------------------------------------------------------------------------
template <class T>
typename albaTimeMap<T>::TimeMap::iterator albaTimeMap<T>::FindItem(T *m)
//----------------------------------------------------------------------------
{
  assert(m);
  return m_TimeMap.find(m->GetTimeStamp());
}
 
//----------------------------------------------------------------------------
template <class T>
void albaTimeMap<T>::Print(std::ostream& os, const int tabs) const
//----------------------------------------------------------------------------
{
  albaIndent indent(tabs);
  os << indent << "Number of Items:"<<GetNumberOfItems()<<"\n";
  mmuTimeVector tvector;
  os << indent << "Time Stamps: {";
  GetTimeStamps(tvector);
  for (unsigned int i=0;i<tvector.size();i++)
  {
    if (i!=0)
    os << ", ";
    os << tvector[i];
  }
 
  os << "}\n";
}
 
//----------------------------------------------------------------------------
template <class T>
albaTimeStamp albaTimeMap<T>::GetItemTime(int idx)
//----------------------------------------------------------------------------
{
  T *m=GetItemByIndex(idx);
  if (m) return m->GetTimeStamp();
  return -1;
}
 
//----------------------------------------------------------------------------
template <class T>
typename albaTimeMap<T>::TimeMap::iterator albaTimeMap<T>::FindItemByIndex(int idx)
//----------------------------------------------------------------------------
{
  if ((unsigned int)idx<m_TimeMap.size() && idx>=0)
  {
     typename albaTimeMap<T>::TimeMap::iterator it=m_TimeMap.begin();
     std::advance(it,idx);
     return it;
  }
  
  return m_TimeMap.end();
}
 
//----------------------------------------------------------------------------
template <class T>
albaID albaTimeMap<T>::FindItemIndex(albaTimeStamp t)
//----------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindItem(t);
  return it!=m_TimeMap.end()?std::distance(m_TimeMap.begin(),it):-1;
}
 
//----------------------------------------------------------------------------
template <class T>
T *albaTimeMap<T>::GetItemByIndex(int idx)
//----------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindItemByIndex(idx);
  return (it!=m_TimeMap.end())?it->second:NULL;
}
 
//----------------------------------------------------------------------------
template <class T>
T *albaTimeMap<T>::GetItem(albaTimeStamp t)
//----------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindItem(t);
  return (it!=m_TimeMap.end())?it->second:NULL;
}
//----------------------------------------------------------------------------
template <class T>
T *albaTimeMap<T>::GetNearestItem(albaTimeStamp t)
//----------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindNearestItem(t);
  return (it!=m_TimeMap.end())?it->second:NULL;
}
//----------------------------------------------------------------------------
template <class T>
T *albaTimeMap<T>::GetItemBefore(albaTimeStamp t)
//----------------------------------------------------------------------------
{
  typename albaTimeMap<T>::TimeMap::iterator it=FindItemBefore(t);
  return (it!=m_TimeMap.end())?it->second:NULL;
}
 
 
#endif