ome-files 0.2.2

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
64 TileBuffer(dimension_size_type size);
65
67 virtual ~TileBuffer();
68
69 private:
70 // To avoid unintentional and expensive copies, copying and
71 // assignment of buffers is prevented.
72
74 TileBuffer (const TileBuffer&);
75
77 TileBuffer&
78 operator= (const TileBuffer&);
79
80 public:
86 dimension_size_type
87 size() const;
88
94 uint8_t *
95 data();
96
102 const uint8_t *
103 data() const;
104
105 private:
107 dimension_size_type bufsize;
109 uint8_t *buf;
110 };
111
112 }
113 }
114
115 #endif // OME_FILES_TILEBUFFER_H
116
117 /*
118 * Local Variables:
119 * mode:C++
120 * End:
121 */
ome::files::TileBuffer::buf
uint8_t * buf
Raw buffer.
Definition: TileBuffer.h:109
ome::files::TileBuffer::bufsize
dimension_size_type bufsize
Buffer size (bytes).
Definition: TileBuffer.h:107
ome::files::TileBuffer::size
dimension_size_type size() const
Get the buffer size.
Definition: TileBuffer.cpp:60
ome::files::dimension_size_type
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:59
ome::files::TileBuffer
Tile pixel data buffer.
Definition: TileBuffer.h:55
ome::files::TileBuffer::data
uint8_t * data()
Get the buffer data.
Definition: TileBuffer.cpp:66
ome::files::TileBuffer::~TileBuffer
virtual ~TileBuffer()
Destructor.
Definition: TileBuffer.cpp:54
ome
Open Microscopy Environment C++.
ome::files::TileBuffer::TileBuffer
TileBuffer(dimension_size_type size)
Constructor.
Definition: TileBuffer.cpp:47
ome::files::TileBuffer::operator=
TileBuffer & operator=(const TileBuffer &)
Assignment operator (deleted).