SequenceNumber.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_SEQUENCE_NUMBER_H_INCLUDED
#define ICL_CORE_SEQUENCE_NUMBER_H_INCLUDED

#include "icl_core/BaseTypes.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {

template <typename TBase, TBase max_value, TBase min_value = 0, TBase initial_value = min_value>
class SequenceNumber
{
public:
  explicit SequenceNumber(TBase value = initial_value)
    : m_value(value)
  {
  }

  SequenceNumber(const SequenceNumber& other)
    : m_value(other.m_value)
  {
  }

  SequenceNumber& operator = (const SequenceNumber& other)
  {
    m_value = other.m_value;
    return *this;
  }

  SequenceNumber& operator = (TBase value)
  {
    m_value = value;
    return *this;
  }

  bool operator < (const SequenceNumber& other) const
  {
    if (m_value < other.m_value)
    {
      return (other.m_value - m_value) < max_value / 2;
    }
    else
    {
      return (m_value - other.m_value) > max_value / 2;
    }
  }

  bool operator <= (const SequenceNumber& other) const
  {
    return (*this) < other || (*this) == other;
  }

  bool operator > (const SequenceNumber& other) const
  {
    return (*this) != other && !((*this) < other);
  }

  bool operator >= (const SequenceNumber& other) const
  {
    return !((*this) < other);
  }

  bool operator == (const SequenceNumber& other) const
  {
    return m_value == other.m_value;
  }

  bool operator != (const SequenceNumber& other) const
  {
    return !((*this) == other);
  }

  SequenceNumber& operator ++ ()
  {
    ++m_value;
    if (m_value >= max_value)
    {
      m_value = min_value;
    }
    return *this;
  }

  SequenceNumber operator ++ (int)
  {
    SequenceNumber result = *this;
    ++(*this);
    return result;
  }

  operator TBase () const
  {
    return m_value;
  }

  static TBase maxValue()
  {
    return max_value;
  }

  static TBase minValue()
  {
    return min_value;
  }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  static ICL_CORE_VC_DEPRECATE_STYLE TBase MaxValue() ICL_CORE_GCC_DEPRECATE_STYLE;

  static ICL_CORE_VC_DEPRECATE_STYLE TBase MinValue() ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  TBase m_value;
};

}

#endif