/*
  Copyright © 2017 Hasan Yavuz Özderya

  This file is part of serialplot.

  serialplot is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  serialplot 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 General Public License
  along with serialplot.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef LININDEXBUFFER_H
#define LININDEXBUFFER_H

// IMPORTANT TODO: rename to "framebuffer.h" when stream work is done.
#include "framebuffer2.h"

/// A dynamic frame buffer that start and end values can be set and
/// intermediate values are calculated linearly.
///
/// @note This buffer isn't for storing data.
class LinIndexBuffer : public ResizableBuffer
{
public:
    LinIndexBuffer(unsigned n, Range lim);
    LinIndexBuffer(unsigned n, double min, double max) :
        LinIndexBuffer(n, {min, max}) {};

    unsigned size() const;
    double sample(unsigned i) const;
    Range limits() const;
    void resize(unsigned n);
    /// Sets minimum and maximum sample values of the buffer.
    void setLimits(Range lim);

private:
    unsigned _size;
    Range _limits;
    double _step;
};

#endif