pv/view/viewitemowner.hpp

   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_VIEWS_TRACEVIEW_VIEWITEMOWNER_HPP
  22 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWITEMOWNER_HPP
  23
  24 #include <memory>
  25 #include <vector>
  26
  27 #include "viewitemiterator.hpp"
  28
  29 namespace pv {
  30
  31 class Session;
  32
  33 namespace views {
  34 namespace TraceView {
  35
  36 class ViewItem;
  37 class View;
  38
  39 class ViewItemOwner
  40 {
  41 public:
  42         typedef std::vector< std::shared_ptr<ViewItem> > item_list;
  43         typedef ViewItemIterator<ViewItemOwner, ViewItem> iterator;
  44         typedef ViewItemIterator<const ViewItemOwner, ViewItem> const_iterator;
  45
  46 public:
  47         /**
  48          * Returns a list of row items owned by this object.
  49          */
  50         virtual const item_list& child_items() const = 0;
  51
  52         /**
  53          * Returns a depth-first iterator at the beginning of the child ViewItem
  54          * tree.
  55          */
  56         iterator begin();
  57
  58         /**
  59          * Returns a depth-first iterator at the end of the child ViewItem tree.
  60          */
  61         iterator end();
  62
  63         /**
  64          * Returns a constant depth-first iterator at the beginning of the
  65          * child ViewItem tree.
  66          */
  67         const_iterator begin() const;
  68
  69         /**
  70          * Returns a constant depth-first iterator at the end of the child
  71          * ViewItem tree.
  72          */
  73         const_iterator end() const;
  74
  75         /**
  76          * Creates a list of descendant signals filtered by type.
  77          */
  78         template<class T>
  79         std::vector< std::shared_ptr<T> > list_by_type() {
  80                 std::vector< std::shared_ptr<T> > items;
  81                 for (const auto &r : *this) {
  82                         std::shared_ptr<T> p = std::dynamic_pointer_cast<T>(r);
  83                         if (p)
  84                                 items.push_back(p);
  85                 }
  86
  87                 return items;
  88         }
  89
  90 protected:
  91         item_list items_;
  92 };
  93
  94 } // namespace TraceView
  95 } // namespace views
  96 } // namespace pv
  97
  98 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWITEMOWNER_HPP