pv/view/tracetreeitemowner.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_TRACETREEITEMOWNER_HPP
  22 #define PULSEVIEW_PV_VIEW_TRACETREEITEMOWNER_HPP
  23
  24 #include <memory>
  25 #include <vector>
  26
  27 #include "rowitemiterator.hpp"
  28
  29 namespace pv {
  30
  31 class Session;
  32
  33 namespace view {
  34
  35 class TraceTreeItem;
  36 class View;
  37
  38 class TraceTreeItemOwner
  39 {
  40 public:
  41         typedef std::vector< std::shared_ptr<TraceTreeItem> > item_list;
  42         typedef RowItemIterator<TraceTreeItemOwner, TraceTreeItem> iterator;
  43         typedef RowItemIterator<const TraceTreeItemOwner, TraceTreeItem> const_iterator;
  44
  45 public:
  46         /**
  47          * Returns the session of the onwer.
  48          */
  49         virtual pv::Session& session() = 0;
  50
  51         /**
  52          * Returns the session of the owner.
  53          */
  54         virtual const pv::Session& session() const = 0;
  55
  56         /**
  57          * Returns the view of the owner.
  58          */
  59         virtual pv::view::View* view() = 0;
  60
  61         /**
  62          * Returns the view of the owner.
  63          */
  64         virtual const pv::view::View* view() const = 0;
  65
  66         virtual int owner_visual_v_offset() const = 0;
  67
  68         /**
  69          * Returns the number of nested parents that this row item owner has.
  70          */
  71         virtual unsigned int depth() const = 0;
  72
  73         /**
  74          * Returns a list of row items owned by this object.
  75          */
  76         virtual item_list& child_items();
  77
  78         /**
  79          * Returns a list of row items owned by this object.
  80          */
  81         virtual const item_list& child_items() const;
  82
  83         /**
  84          * Clears the list of child items.
  85          */
  86         void clear_child_items();
  87
  88         /**
  89          * Adds a child item to this object.
  90          */
  91         void add_child_item(std::shared_ptr<TraceTreeItem> item);
  92
  93         /**
  94          * Removes a child item from this object.
  95          */
  96         void remove_child_item(std::shared_ptr<TraceTreeItem> item);
  97
  98         /**
  99          * Returns a depth-first iterator at the beginning of the child TraceTreeItem
 100          * tree.
 101          */
 102         iterator begin();
 103
 104         /**
 105          * Returns a depth-first iterator at the end of the child TraceTreeItem tree.
 106          */
 107         iterator end();
 108
 109         /**
 110          * Returns a constant depth-first iterator at the beginning of the
 111          * child TraceTreeItem tree.
 112          */
 113         const_iterator begin() const;
 114
 115         /**
 116          * Returns a constant depth-first iterator at the end of the child
 117          * TraceTreeItem tree.
 118          */
 119         const_iterator end() const;
 120
 121         /**
 122          * Creates a list of decendant signals filtered by type.
 123          */
 124         template<class T>
 125         std::vector< std::shared_ptr<T> > list_by_type() {
 126                 std::vector< std::shared_ptr<T> > items;
 127                 for (const auto &r : *this) {
 128                         std::shared_ptr<T> p = std::dynamic_pointer_cast<T>(r);
 129                         if (p)
 130                                 items.push_back(p);
 131                 }
 132
 133                 return items;
 134         }
 135
 136         /**
 137          * Computes the vertical extents of the contents of this row item owner.
 138          * @return A pair containing the minimum and maximum y-values.
 139          */
 140         std::pair<int, int> v_extents() const;
 141
 142         virtual void restack_items();
 143
 144 public:
 145         virtual void row_item_appearance_changed(bool label, bool content) = 0;
 146
 147         virtual void extents_changed(bool horz, bool vert) = 0;
 148
 149 private:
 150         item_list items_;
 151 };
 152
 153 } // view
 154 } // pv
 155
 156 #endif // PULSEVIEW_PV_VIEW_TRACETREEITEMOWNER_HPP