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