$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
site_set_iterator_base.hh
1 // Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and
2 // Development 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_SITE_SET_ITERATOR_BASE_HH
28 # define MLN_CORE_INTERNAL_SITE_SET_ITERATOR_BASE_HH
29 
34 
35 # include <mln/core/internal/site_iterator_base.hh>
36 
37 
38 namespace mln
39 {
40 
41  namespace internal
42  {
43 
54  template <typename S, typename E>
56  {
57  public:
58 
60  typedef S pset;
61 
63  const S& site_set() const;
64 
66  void change_target(const S& s);
67 
70  const mln_psite(S)& p_hook_() const;
71 
74  void change_target_(const S& s);
76 
77  protected:
78 
80  mln_psite(S) p_;
81 
84  };
85 
86 
87 #ifndef MLN_INCLUDE_ONLY
88 
89  template <typename S, typename E>
90  inline
92  {
93  }
94 
95  template <typename S, typename E>
96  inline
97  const S&
99  {
100  mln_precondition(this->s_ != 0);
101  return *this->s_;
102  }
103 
104  template <typename S, typename E>
105  inline
106  void
108  {
109  this->s_ = & s;
110  // p might be also updated since it can hold a pointer towards
111  // the set it designates, so:
113  // Likewise, the iterator might need to update specific data.
114  exact(this)->change_target_(s);
115  // Last:
116  this->invalidate();
117  }
118 
119  template <typename S, typename E>
120  inline
121  void
123  {
124  (void) s;
125  // Empty by default.
126  }
127 
128  template <typename S, typename E>
129  inline
130  const mln_psite(S)&
132  {
133  return p_;
134  }
135 
136 #endif // ! MLN_INCLUDE_ONLY
137 
138  } // end of namespace internal
139 
140 } // end of namespace mln
141 
142 
143 #endif // ! MLN_CORE_INTERNAL_SITE_SET_ITERATOR_BASE_HH