summaryrefslogtreecommitdiff
path: root/i/chuck/src/data/data_circular_buffer.hh
blob: f08426d3fe70de8125dd9afcfa25534266cf1860 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
#ifndef data_circular_buffer_hh
#define data_circular_buffer_hh
// data_circular_buffer.hh
// marvin - programme du robot 2006. {{{
//
// Copyright (C) 2006 Dufour J�r�my
//
// Robot APB Team/Efrei 2004.
//        Web: http://assos.efrei.fr/robot/
//      Email: robot AT efrei DOT fr
//
// This program 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 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 General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}

#include "data_input.hh"
#include "data_output.hh"

#include <stdint.h> 		// uint8_t

class DataCircularBuffer : public DataInput, public DataOutput
{
  private:
    /// Calculate the quantity of maximum data we can read.
    unsigned maxReadableData (void)
      { return (endPos_ + size_ - startPos_) % size_; }
    /// Internal read, do the real job.
    unsigned internalRead (uint8_t *data, unsigned size);
    /// Buffer.
    uint8_t *buffer_;
    /// Size of the buffer.
    unsigned size_;
    /// Start and end positions of data in the buffer.
    unsigned startPos_, endPos_;
  public:
    /// Default constructor.
    /// Size is the allocated size in memory.
    DataCircularBuffer (unsigned size);
    /// Destructor.
    ~DataCircularBuffer (void);
    /// Read data of maximum size in the data pointer (data must be allocated
    /// of size).
    unsigned read (uint8_t *data, unsigned size);
    /// Write data of size length.
    void write (const uint8_t *data, unsigned size);
    /// Size of the buffer.
    unsigned size (void) const { return size_; }
    /// Swap data between tow DataCircularBuffer.
    void swap (DataCircularBuffer &d);
};

#endif // data_circular_buffer_hh