pv/data/decode/rowdata.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef PULSEVIEW_PV_DATA_DECODE_ROWDATA_H
  22 #define PULSEVIEW_PV_DATA_DECODE_ROWDATA_H
  23
  24 #include <vector>
  25
  26 #include "annotation.h"
  27
  28 namespace pv {
  29 namespace data {
  30 namespace decode {
  31
  32 class RowData
  33 {
  34 public:
  35         RowData();
  36
  37 public:
  38         uint64_t get_max_sample() const;
  39
  40         /**
  41          * Extracts sorted annotations between two period into a vector.
  42          */
  43         void get_annotation_subset(
  44                 std::vector<pv::data::decode::Annotation> &dest,
  45                 uint64_t start_sample, uint64_t end_sample) const;
  46
  47         void push_annotation(const Annotation& a);
  48
  49 private:
  50         bool index_entry_start_sample_gt(
  51                 const uint64_t sample, const size_t index) const;
  52         bool index_entry_end_sample_lt(
  53                 const size_t index, const uint64_t sample) const;
  54         bool index_entry_end_sample_gt(
  55                 const uint64_t sample, const size_t index) const;
  56
  57 private:
  58         std::vector<Annotation> _annotations;
  59
  60         /**
  61          * _ann_start_index and _ann_end_index contain lists of annotions
  62          * (represented by offsets in the _annotations vector), sorted in
  63          * ascending ordered by the start_sample and end_sample respectively.
  64          */
  65         std::vector<size_t> _ann_start_index, _ann_end_index;
  66 };
  67
  68 }
  69 } // data
  70 } // pv
  71
  72 #endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_H