logicdatasnapshot.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 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 #include "datasnapshot.h"
  22
  23 #include <utility>
  24 #include <vector>
  25
  26 class LogicDataSnapshot : public DataSnapshot
  27 {
  28 public:
  29         typedef std::pair<int64_t, bool> EdgePair;
  30
  31 public:
  32         LogicDataSnapshot(const sr_datafeed_logic &logic);
  33
  34         void append_payload(const sr_datafeed_logic &logic);
  35
  36         uint64_t get_sample(uint64_t index) const;
  37
  38         /**
  39          * Parses a logic data snapshot to generate a list of transitions
  40          * in a time interval to a given level of detail.
  41          * @param[out] edges The vector to place the edges into.
  42          * @param[in] start The start sample index.
  43          * @param[in] end The end sample index.
  44          * @param[in] quantization_length The minimum period of time that
  45          * can be resolved at this level of detail.
  46          * @param[in] sig_index The index of the signal.
  47          **/
  48         void get_subsampled_edges(std::vector<EdgePair> &edges,
  49                 int64_t start, int64_t end,
  50                 int64_t quantization_length, int sig_index);
  51 };