ome-files  0.5.0
TileBuffer.h
1 /*
2  * #%L
3  * OME-FILES C++ library for image IO.
4  * Copyright © 2006 - 2015 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #ifndef OME_FILES_TILEBUFFER_H
39 #define OME_FILES_TILEBUFFER_H
40 
41 #include <ome/files/Types.h>
42 
43 #include <ome/xml/model/enums/PixelType.h>
44 
45 namespace ome
46 {
47  namespace files
48  {
49 
55  class TileBuffer
56  {
57  public:
63  explicit
65 
67  virtual ~TileBuffer();
68 
69  // To avoid unintentional and expensive copies, copying and
70  // assignment of buffers is prevented.
71 
73  TileBuffer (const TileBuffer&) = delete;
74 
75  TileBuffer&
76  operator= (const TileBuffer&) = delete;
78 
85  size() const;
86 
92  uint8_t *
93  data();
94 
100  const uint8_t *
101  data() const;
102 
103  private:
107  uint8_t *buf;
108  };
109 
110  }
111 }
112 
113 #endif // OME_FILES_TILEBUFFER_H
114 
115 /*
116  * Local Variables:
117  * mode:C++
118  * End:
119  */
uint8_t * buf
Raw buffer.
Definition: TileBuffer.h:107
dimension_size_type bufsize
Buffer size (bytes).
Definition: TileBuffer.h:105
SKIP dimension_size_type size() const
Get the buffer size.
Definition: TileBuffer.cpp:60
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:58
Tile pixel data buffer.
Definition: TileBuffer.h:55
uint8_t * data()
Get the buffer data.
Definition: TileBuffer.cpp:66
virtual ~TileBuffer()
Destructor.
Definition: TileBuffer.cpp:54
Open Microscopy Environment C++.
TileBuffer(dimension_size_type size)
Constructor.
Definition: TileBuffer.cpp:47