]> sigrok.org Git - pulseview.git/blame - pv/view/viewitemowner.hpp
Added ViewItemOwner
[pulseview.git] / pv / view / viewitemowner.hpp
CommitLineData
c373f828
JH
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
29namespace pv {
30
31class Session;
32
33namespace view {
34
35class ViewItem;
36class View;
37
38class ViewItemOwner
39{
40public:
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
45public:
46 /**
47 * Returns a list of row items owned by this object.
48 */
49 virtual item_list& child_items() = 0;
50
51 /**
52 * Returns a list of row items owned by this object.
53 */
54 virtual const item_list& child_items() const = 0;
55
56 /**
57 * Returns a depth-first iterator at the beginning of the child ViewItem
58 * tree.
59 */
60 iterator begin();
61
62 /**
63 * Returns a depth-first iterator at the end of the child ViewItem tree.
64 */
65 iterator end();
66
67 /**
68 * Returns a constant depth-first iterator at the beginning of the
69 * child ViewItem tree.
70 */
71 const_iterator begin() const;
72
73 /**
74 * Returns a constant depth-first iterator at the end of the child
75 * ViewItem tree.
76 */
77 const_iterator end() const;
78
79 /**
80 * Creates a list of decendant signals filtered by type.
81 */
82 template<class T>
83 std::vector< std::shared_ptr<T> > list_by_type() {
84 std::vector< std::shared_ptr<T> > items;
85 for (const auto &r : *this) {
86 std::shared_ptr<T> p = std::dynamic_pointer_cast<T>(r);
87 if (p)
88 items.push_back(p);
89 }
90
91 return items;
92 }
93
94protected:
95 item_list items_;
96};
97
98} // view
99} // pv
100
101#endif // PULSEVIEW_PV_VIEW_VIEWITEMOWNER_HPP