1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* band.h (C) 2006-2008, Aurélien Croc (AP²C)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program 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
* along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id: band.h 140 2008-01-31 18:33:18Z ap2c $
*
*/
#ifndef _BAND_H_
#define _BAND_H_
#include <stddef.h>
class Page;
class BandPlane;
/**
* @brief This class contains all information related to a band.
*
*/
class Band
{
protected:
unsigned long _bandNr;
const Page* _parent;
unsigned char _colors;
BandPlane* _planes[4];
unsigned long _width;
unsigned long _height;
Band* _sibling;
public:
/**
* Initialize the band instance.
*/
Band();
/**
* Initialize the band instance.
* @param nr the band number
* @param width the band width
* @param height the band height
*/
Band (unsigned long nr, unsigned long width, unsigned long height);
/**
* Destroy the instance
*/
virtual ~Band();
public:
/**
* Set the band number.
* @param nr the band number
*/
void setBandNr(unsigned long nr) {_bandNr = nr;}
/**
* Register the parent @ref Page instance.
* @param parent the parent page instance
*/
void registerParent(const Page* parent)
{_parent = parent;}
/**
* Register a new plane.
* @param plane the band plane
*/
void registerPlane(BandPlane* plane)
{if (_colors < 4) {_planes[_colors] = plane;
_colors++;}}
/**
* Set the band width.
* @param width the band width
*/
void setWidth(unsigned long width)
{_width = width;}
/**
* Set the band height.
* @param height the band height
*/
void setHeight(unsigned long height)
{_height = height;}
/**
* Register sibling.
* @param sibling the sibling.
*/
void registerSibling(Band* sibling)
{_sibling = sibling;}
/**
* @return the band number.
*/
unsigned long bandNr() const {return _bandNr;}
/**
* @return the number of registered planes.
*/
unsigned long planesNr() const {return _colors;}
/**
* @return the parent @ref Page instance.
*/
const Page* parent() const {return _parent;}
/**
* Get a specific band plane.
* @param nr the band plane number
* @return the @ref BandPlane instance if it exists. Otherwise it
* returns NULL.
*/
const BandPlane* plane(unsigned char nr) const
{return nr < _colors ? _planes[nr] : NULL;}
/**
* @return the band width.
*/
unsigned long width() const {return _width;}
/**
* @return the band height.
*/
unsigned long height() const {return _height;}
/**
* @return the next sibling or NULL if there is no sibling.
*/
Band* sibling() const {return _sibling;}
public:
/**
* Swap this instance on the disk.
* @param fd the file descriptor where the instance has to be swapped
* @return TRUE if the instance has been successfully swapped.
* Otherwise it returns FALSE.
*/
bool swapToDisk(int fd);
/**
* Restore an instance from the disk into memory.
* @param fd the file descriptor where the instance has been swapped
* @return a band instance if it has been successfully restored.
* Otherwise it returns NULL.
*/
static Band* restoreIntoMemory(int fd);
};
#endif /* _BAND_H_ */
/* vim: set expandtab tabstop=4 shiftwidth=4 smarttab tw=80 cin enc=utf8: */
|
