ome-xml 5.2.3

Binning.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 /*─────────────────────────────────────────────────────────────────────────────
40 *
41 * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42 *
43 *─────────────────────────────────────────────────────────────────────────────
44 */
45
46 #ifndef OME_XML_MODEL_ENUMS_BINNING_H
47 #define OME_XML_MODEL_ENUMS_BINNING_H
48
49 #include <ostream>
50 #include <map>
51 #include <string>
52
53 #include <ome/common/log.h>
54
55 #include <ome/xml/model/enums/EnumerationException.h>
56
57 // All values in the Binning enumeration.
58 #define OME_XML_MODEL_ENUMS_BINNING_VALUES (ONEBYONE)(TWOBYTWO)(FOURBYFOUR)(EIGHTBYEIGHT)(OTHER)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class Binning
73 {
74 public:
76 enum enum_value
77 {
81 ONEBYONE,
85 TWOBYTWO,
89 FOURBYFOUR,
93 EIGHTBYEIGHT,
97 OTHER
98 };
99
105 Binning (enum_value value);
106
121 Binning (const std::string& name, bool strict = true);
122
128 Binning (const Binning& original);
129
134 inline Binning&
135 operator= (const Binning& rhs)
136 {
137 this->value = rhs.value;
138 this->name = rhs.name;
139 return *this;
140 }
141
147 inline
148 operator enum_value () const
149 {
150 return this->value;
151 }
152
158 inline
159 operator const std::string& () const
160 {
161 return *this->name;
162 }
163
165 typedef std::map<std::string, Binning::enum_value> string_map_type;
167 typedef std::map<Binning::enum_value, std::string> value_map_type;
168
174 static const string_map_type&
175 strings();
176
182 static const value_map_type&
183 values();
184
185 private:
191 static const string_map_type&
192 lowercase_strings();
193
195 enum_value value;
197 const std::string *name;
198 };
199
207 inline bool
208 operator== (const Binning& lhs,
209 const Binning& rhs)
210 {
211 return static_cast<Binning::enum_value>(lhs) == static_cast<Binning::enum_value>(rhs);
212 }
213
221 inline bool
222 operator== (const Binning& lhs,
223 const Binning::enum_value& rhs)
224 {
225 return static_cast<Binning::enum_value>(lhs) == rhs;
226 }
227
235 inline bool
236 operator== (const Binning::enum_value& lhs,
237 const Binning& rhs)
238 {
239 return lhs == static_cast<Binning::enum_value>(rhs);
240 }
241
249 inline bool
250 operator== (const Binning& lhs,
251 const std::string& rhs)
252 {
253 return static_cast<const std::string&>(lhs) == rhs;
254 }
255
263 inline bool
264 operator== (const std::string& lhs,
265 const Binning& rhs)
266 {
267 return lhs == static_cast<const std::string&>(rhs);
268 }
269
277 inline bool
278 operator!= (const Binning& lhs,
279 const Binning& rhs)
280 {
281 return static_cast<Binning::enum_value>(lhs) != static_cast<Binning::enum_value>(rhs);
282 }
283
291 inline bool
292 operator!= (const Binning& lhs,
293 const Binning::enum_value& rhs)
294 {
295 return static_cast<Binning::enum_value>(lhs) != rhs;
296 }
297
305 inline bool
306 operator!= (const Binning::enum_value& lhs,
307 const Binning& rhs)
308 {
309 return lhs != static_cast<Binning::enum_value>(rhs);
310 }
311
319 inline bool
320 operator!= (const Binning& lhs,
321 const std::string& rhs)
322 {
323 return static_cast<const std::string&>(lhs) != rhs;
324 }
325
333 inline bool
334 operator!= (const std::string& lhs,
335 const Binning& rhs)
336 {
337 return lhs != static_cast<const std::string&>(rhs);
338 }
339
347 template<class charT, class traits>
348 inline std::basic_ostream<charT,traits>&
349 operator<< (std::basic_ostream<charT,traits>& os,
350 const Binning& enumeration)
351 {
352 return os << static_cast<const std::string&>(enumeration);
353 }
354
362 template<class charT, class traits>
363 inline std::basic_istream<charT,traits>&
364 operator>> (std::basic_istream<charT,traits>& is,
365 Binning& enumeration)
366 {
367 std::string value;
368 is >> value;
369 if (is)
370 {
371 try
372 {
373 enumeration = Binning(value, false);
374 }
375 catch (const EnumerationException&)
376 {
377 is.setstate(std::ios::failbit);
378 }
379 }
380
381 return is;
382 }
383
384 }
385 }
386 }
387 }
388
389 #endif // OME_XML_MODEL_ENUMS_BINNING_H
390
391 /*
392 * Local Variables:
393 * mode:C++
394 * End:
395 */
ome::xml::model::enums::operator>>
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:390
ome::xml::model::enums::Binning::value_map_type
std::map< Binning::enum_value, std::string > value_map_type
Value map type.
Definition: Binning.h:167
ome::xml::model::enums::operator!=
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:304
ome::xml::model::enums::Binning::operator=
Binning & operator=(const Binning &rhs)
Assignment operator.
Definition: Binning.h:135
ome::xml::model::enums::Binning::TWOBYTWO
2×2 binning.
Definition: Binning.h:85
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::Binning
Binning enumeration.
Definition: Binning.h:72
ome::xml::model::enums::Binning::ONEBYONE
No binning.
Definition: Binning.h:81
ome::xml::model::enums::Binning::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Binning.cpp:171
ome::xml::model::enums::Binning::FOURBYFOUR
4×4 binning.
Definition: Binning.h:89
ome::xml::model::enums::Binning::EIGHTBYEIGHT
8×8 binning.
Definition: Binning.h:93
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::Binning::string_map_type
std::map< std::string, Binning::enum_value > string_map_type
String map type.
Definition: Binning.h:165
ome::xml::model::enums::operator==
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:234
ome::xml::model::enums::Binning::enum_value
enum_value
Enumeration values.
Definition: Binning.h:76
ome::xml::model::enums::Binning::value
enum_value value
Enumeration value.
Definition: Binning.h:195
ome::xml::model::enums::Binning::OTHER
Other binning value.
Definition: Binning.h:97
ome::xml::model::enums::Binning::Binning
Binning(enum_value value)
Construct a Binning enumeration by an enumeration value.
Definition: Binning.cpp:75
ome::xml::model::enums::Binning::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: Binning.cpp:189
ome::xml::model::enums::Binning::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Binning.cpp:153
ome::xml::model::enums::Binning::name
const std::string * name
Enumeration name.
Definition: Binning.h:197
log.h