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