$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
neighb_base.hh
1 // Copyright (C) 2009, 2012, 2013 EPITA Research and Development
2 // Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_CORE_INTERNAL_NEIGHB_BASE_HH
28 # define MLN_CORE_INTERNAL_NEIGHB_BASE_HH
29 
33 
34 # include <mln/core/internal/neighborhood_base.hh>
35 # include <mln/core/internal/site_relative_iterator_base.hh>
36 # include <mln/core/internal/neighb_niter_impl.hh>
37 
38 
39 namespace mln
40 {
41 
42  namespace internal
43  {
44 
45 
53  template <typename W, typename E>
55  : public internal::neighborhood_base< W, E >,
56  private mlc_is_a(W, Window)::check_t
57  {
58  public:
59 
61  neighb_base();
62 
64  neighb_base(const W& win);
65 
67  const W& win() const;
68 
70  void change_window(const W& new_win);
71 
72 
75  W& hook_win_();
77 
78  private:
79 
80  W win_;
81  };
82 
83 
84 # ifndef MLN_INCLUDE_ONLY
85 
86  // neighb<W,E>
87 
88  template <typename W, typename E>
89  inline
91  {
92  }
93 
94  template <typename W, typename E>
95  inline
96  neighb_base<W,E>::neighb_base(const W& win)
97  {
98  change_window(win);
99  }
100 
101  template <typename W, typename E>
102  inline
103  const W&
104  neighb_base<W,E>::win() const
105  {
106  return win_;
107  }
108 
109  template <typename W, typename E>
110  inline
111  void
112  neighb_base<W,E>::change_window(const W& new_win)
113  {
114  mln_precondition(new_win.is_neighbable_());
115  win_ = new_win;
116  }
117 
118  template <typename W, typename E>
119  inline
120  W&
122  {
123  return win_;
124  }
125 
126 # endif // ! MLN_INCLUDE_ONLY
127 
128  } // end of namespace mln::internal
129 
130 } // end of namespace mln
131 
132 
133 #endif // ! MLN_CORE_INTERNAL_NEIGHB_BASE_HH