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