revision_counter.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef __H__UG__LIB_DISC__COMMON__REVISION_COUNTER__
#define __H__UG__LIB_DISC__COMMON__REVISION_COUNTER__
 
#include "common/common.h"
 
namespace ug{
 
 
class RevisionCounter
{
  public:
    RevisionCounter() : m_pObj(0), m_cnt(0) {};
 
    RevisionCounter(const void* pObj) : m_pObj(pObj), m_cnt(1) {}
 
    template <typename T>
    RevisionCounter(const T* pObj) : m_pObj(static_cast<const void*>(pObj)), m_cnt(1) {}
 
    RevisionCounter& operator++() {
      if(invalid())
        UG_THROW("AdaptState: increasing invalid state not admissible.")
 
      ++m_cnt;
 
      if(invalid())
        UG_THROW("AdaptState: counter overflow. Alter implementation.")
      return *this;
    }
 
    RevisionCounter operator++(int) {
      RevisionCounter tmp(*this);
      ++(*this);
      return tmp;
    }
 
    bool operator==(const RevisionCounter& rhs) const{
      if(invalid() || rhs.invalid()) return false;
      if(m_pObj != rhs.m_pObj) return false;
      return (m_cnt == rhs.m_cnt);
    }
 
    bool operator!=(const RevisionCounter& rhs) const{
      return !((*this) == rhs);
    }
 
    bool operator<(const RevisionCounter& rhs) const{
      if(m_pObj != rhs.m_pObj) return m_pObj < rhs.m_pObj;
      if(m_cnt != rhs.m_cnt) return m_cnt < rhs.m_cnt;
      return false;
    }
 
    bool operator>(const RevisionCounter& rhs) const{
      if(m_pObj != rhs.m_pObj) return m_pObj > rhs.m_pObj;
      if(m_cnt != rhs.m_cnt) return m_cnt > rhs.m_cnt;
      return false;
    }
 
    bool valid() const {return m_pObj != 0 && m_cnt != 0;}
 
    bool invalid() const {return !valid();}
 
    void invalidate() {m_pObj = 0; m_cnt = 0;}
 
    const void* obj() const {return m_pObj;}
 
  protected:
    const void* m_pObj; 
    uint64 m_cnt; 
};
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__COMMON__REVISION_COUNTER__ */