IsCloseTo.h

Go to the documentation of this file.

/**************************************************************************

   begin                : Sat Aug 21 2004
   copyright            : (C) 2002-2010 by Ewald Arnold
   email                : mockpp at ewald-arnold dot de

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

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

   You should have received a copy of the GNU Lesser General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

   *
   *  Original Java Sources:  Copyright (c) 2000-2004, jMock.org
   *

 **/

#ifndef MOCKPP_ISCLOSETO_H
#define MOCKPP_ISCLOSETO_H

#include <mockpp/mockpp.h> // always first

#include <mockpp/constraint/Constraint.h>
#include <mockpp/compat/Formatter.h>


MOCKPP_NS_START


template <typename NumberType>
class IsCloseTo : public Constraint<NumberType>
{
  public:

    IsCloseTo( const NumberType &in_value, const NumberType &in_deviation )
      : value(in_value)
      , deviation(in_deviation)
    {}

    virtual bool eval( const NumberType &arg ) const
    {
       // don't use std::abs to better support user types
       return    (arg <= value + deviation && arg >= value - deviation)  // positive deviation
              || (arg <= value - deviation && arg >= value + deviation); // negative deviation
    }

    virtual String describeTo( String &buffer ) const
    {
      String fmt = MOCKPP_PCHAR("a numeric value within +-%1 of %2");
      fmt << deviation << value;
      buffer += fmt;
      return buffer;
    }

  private:

    const NumberType value;
    const NumberType deviation;
};


MOCKPP_NS_END


#endif // MOCKPP_ISCLOSETO_H

---