adler16.h

Go to the documentation of this file.

//
// srecord - manipulate eprom load files
// Copyright (C) 2009, 2010 Peter Miller
//
// 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 3 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 Lesser 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, see
// <http://www.gnu.org/licenses/>.
//
 
#ifndef SRECORD_MEMORY_WALKER_ADLER16_H
#define SRECORD_MEMORY_WALKER_ADLER16_H
 
#include <srecord/adler16.h>
#include <srecord/memory/walker.h>
 
namespace srecord
{
 
/**
  * The srecord::memory_walker_adler16 class is used to represent the parse
  * state of a memory walker which calculates a running ADLER16 checksum.
  */
class memory_walker_adler16:
    public memory_walker
{
public:
    typedef std::shared_ptr<memory_walker_adler16> pointer;
 
    /**
      * The destructor.
      */
    virtual ~memory_walker_adler16();
 
private:
    /**
      * The default constructor.  It is private on putpose, use the
      * #create method instead.
      */
    memory_walker_adler16();
 
public:
    /**
      * The create class method is used to create new dynamically
      * allocated instances of this class.
      */
    static pointer create();
 
    /**
      * The get method is used to get the ADLER16 checksum once all memory
      * chunks have been processed by calls to our observe method.
      */
    unsigned get() const;
 
protected:
    // See base class for documentation.
    void observe(unsigned long, const void *, int);
 
private:
    /**
      * The checksum instance variable is used to remember the running
      * state of the ADLER16 checksum calculation.
      */
    adler16 checksum;
 
    /**
      * The copy constructor.  Do not use.
      */
    memory_walker_adler16(const memory_walker_adler16 &);
 
    /**
      * The assignment operator.  Do not use.
      */
    memory_walker_adler16 &operator=(const memory_walker_adler16 &);
};
 
};
 
#endif // SRECORD_MEMORY_WALKER_ADLER16_H