TrackingCounter.h

Go to the documentation of this file.

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

   begin                : Fri Feb 18 2005
   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.

 **/

#ifndef MOCKPP_TrackingCounter_H
#define MOCKPP_TrackingCounter_H


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

#include <mockpp/AbstractExpectation.h>

#include MOCKPP_VECTOR_H


MOCKPP_NS_START


class MOCKPP_API_DECL0 TrackingCounterBase : public AbstractExpectation<unsigned>
{
  public:

    TrackingCounterBase(const String &name, VerifiableList *parent = 0);

    virtual void clearActual() = 0;

    virtual void reset();

    void setExpected(unsigned  expectedValue);

    void setExpected(unsigned expectedMinValue, unsigned expectedMaxValue);

    void setExpectNothing();

    virtual unsigned getActual() const = 0;

  protected:

    unsigned getExpectedMinValue() const;

    unsigned getExpectedMaxValue() const;

    virtual void clearExpectation();

    virtual bool isExpectNothing() const;

  private:

    unsigned myExpectedMinVal;
    unsigned myExpectedMaxVal;
    bool     expectNothing;
};


class TrackingCounterClient;


class MOCKPP_API_DECL0 TrackingCounterMaster : public TrackingCounterBase
{
  public:

    TrackingCounterMaster(const String &name, VerifiableList *parent = 0);

    virtual void verify();

    virtual void clearActual();

    virtual unsigned getActual() const;

    unsigned numClients () const;

  protected:

    friend class TrackingCounterClient;

    virtual void addClient (TrackingCounterClient* vf);

    void removeClient (TrackingCounterClient* vf);

    unsigned increment();

  private:

    TrackingCounterMaster (const TrackingCounterMaster &);    // forbid
    TrackingCounterMaster& operator=(TrackingCounterMaster&);

    MOCKPP_STL::vector<TrackingCounterClient*>  clients;
    unsigned myActualValue;
};


class MOCKPP_API_DECL0 TrackingCounterClient : public TrackingCounterBase
{
  public:

    TrackingCounterClient(const String &name, TrackingCounterMaster &master);

    virtual ~TrackingCounterClient();

    unsigned inc();

    unsigned operator++ ()
    {
      return inc();
    }

    unsigned operator++ (int)
    {
      return inc();
    }

    virtual void verify();

    virtual void clearActual();

    virtual unsigned getActual() const;

    unsigned numTags() const;

    unsigned getTag(unsigned index) const;

 private:

    TrackingCounterClient (const TrackingCounterClient &);    // forbid
    TrackingCounterClient& operator=(TrackingCounterClient&);

    MOCKPP_STL::vector<unsigned>   countervalues;
    TrackingCounterMaster  *master;
    unsigned                myActualValue;
};


MOCKPP_NS_END


#endif // MOCKPP_TrackingCounter_H

---