image.hh 4.01 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Copyright (C) 2001, 2003, 2004, 2005, 2006 EPITA Research and
// Development Laboratory
//
// This file is part of the Olena Library.  This library is free
// software; you can redistribute it and/or modify it under the terms
// of the GNU General Public License version 2 as published by the
// Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
Roland Levillain's avatar
Roland Levillain committed
15
16
17
// along with this library; see the file COPYING.  If not, write to
// the Free Software Foundation, 51 Franklin Street, Fifth Floor,
// Boston, MA 02111-1307, USA.
18
19
20
21
22
23
24
25
26
27
28
29
30
31
//
// As a special exception, you may use this file as part of a free
// software library without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to
// produce an executable, this file does not by itself cause the
// resulting executable to be covered by the GNU General Public
// License.  This exception does not however invalidate any other
// reasons why the executable file might be covered by the GNU General
// Public License.

#ifndef OLENA_CORE_ABSTRACT_IMAGE_HH
# define OLENA_CORE_ABSTRACT_IMAGE_HH

32
33
# include <oln/core/typedefs.hh>
// # include <oln/core/abstract/internal/image_impl.hh>
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56



namespace oln
{

  /*! \namespace oln::abstract
  ** \brief oln::abstract namespace.
  */
  namespace abstract {


    /*! \class abstract::image<E>
    **
    ** The abstract::image class is the base class from whom derives
    ** every concrete image class.  Basically, an image is a set of
    ** points and a set of values associated with those points.
    **
    ** Parameter E is the exact type of image.
    */


    template <typename E>
57
58
59
    struct image : public virtual stc::any__simple<E>,
		   public virtual oln::type
      // , public internal::get_image_impl < image<E>, E >
60
61
    {

62
    public:
63

64
      struct decl {
65

66
67
	stc_virtual_typedef(topo);
	stc_virtual_typedef(grid);
68

69
70
	stc_virtual_typedef(psite);
	stc_virtual_typedef(point);
71

72
73
74
	stc_virtual_typedef(piter);
	stc_virtual_typedef(fwd_piter);
	stc_virtual_typedef(bkd_piter);
75

76
77
	stc_virtual_typedef(value);
	stc_virtual_typedef(rvalue);
78

79
	stc_virtual_typedef(concrete);
80

81
82
83
84
	decl() {
	  // FIXME: ...
	}
      };
85
86


87
    private:
88

89
90
91
92
      /// Typedefs.
      typedef oln_type_of(E, topo)   topo_t;
      typedef oln_type_of(E, psite)  psite_t;
      typedef oln_type_of(E, rvalue) rvalue_t;
93
94


95
    public:
96
97

      /*------------------*
98
       ! abstract methods !
99
100
       *------------------*/

101
102
103
      /*! \brief Return the topological information about the current
      **  image.  Nota bene: this method is abstract-like.it is a
      **  pseudo-abstract method.
104
      **
105
106
107
      ** \return An object deriving from abstract::topo.  Ex: if the
      ** image is an image2d<something>, the returned object is a
      ** topo2d.
108
109
      */

110
111
112
113
      const topo_t& topo() const
      {
	return this->exact().impl_topo();
      }
114
115
116


      /*! \brief Gives access to the value stored at \a p in the
117
      ** current image.
118
119
      */

120
      rvalue_t operator()(const psite_t& p) const
121
      {
122
	return this->exact().impl_op_read(p);
123
124
125
      }


126
127
128
      /*! \brief Test if the point \a p belongs to the current image.
      ** Please note that a point of the outer boundary of an image
      ** does NOT belong to the image.
129
      **
130
      ** \return True if p belongs to the current image, false otherwise.
131
      **
132
      ** \see hold_large
133
134
      */

135
136
137
138
      bool has(const psite_t& p) const
      {
	return this->exact().impl_has(p);
      }
139
140
141
142
143
144
145

    protected:

      /*! \brief Constructor (protected, empty).
      */
      image() {}

146
      /*! \brief Destructor.
147
      */
148
      virtual ~image() { decl(); }
149
150
151
152
153
154
155
156
157
158
159

    };


  } // end of namespace oln::abstract

} // end of namespace oln



#endif // ! OLENA_CORE_ABSTRACT_IMAGE_HH