bioformats  5.1.2
PixelType.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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_PIXELTYPE_H
47 #define OME_XML_MODEL_ENUMS_PIXELTYPE_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 
58 namespace ome
59 {
60  namespace xml
61  {
62  namespace model
63  {
64  namespace enums
65  {
66 
70  class PixelType
71  {
72  public:
75  {
91  BIT,
98  };
99 
106 
121  PixelType (const std::string& name, bool strict = true);
122 
128  PixelType (const PixelType& original);
129 
134  inline PixelType&
135  operator= (const PixelType& 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, PixelType::enum_value> string_map_type;
167  typedef std::map<PixelType::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:
189  const std::string *name;
190 
192  static const string_map_type string_map;
194  static const string_map_type lowercase_string_map;
196  static const value_map_type value_map;
197  };
198 
206  inline bool
207  operator== (const PixelType& lhs,
208  const PixelType& rhs)
209  {
210  return static_cast<PixelType::enum_value>(lhs) == static_cast<PixelType::enum_value>(rhs);
211  }
212 
220  inline bool
221  operator== (const PixelType& lhs,
222  const PixelType::enum_value& rhs)
223  {
224  return static_cast<PixelType::enum_value>(lhs) == rhs;
225  }
226 
234  inline bool
236  const PixelType& rhs)
237  {
238  return lhs == static_cast<PixelType::enum_value>(rhs);
239  }
240 
248  inline bool
249  operator== (const PixelType& lhs,
250  const std::string& rhs)
251  {
252  return static_cast<const std::string&>(lhs) == rhs;
253  }
254 
262  inline bool
263  operator== (const std::string& lhs,
264  const PixelType& rhs)
265  {
266  return lhs == static_cast<const std::string&>(rhs);
267  }
268 
276  inline bool
277  operator!= (const PixelType& lhs,
278  const PixelType& rhs)
279  {
280  return static_cast<PixelType::enum_value>(lhs) != static_cast<PixelType::enum_value>(rhs);
281  }
282 
290  inline bool
291  operator!= (const PixelType& lhs,
292  const PixelType::enum_value& rhs)
293  {
294  return static_cast<PixelType::enum_value>(lhs) != rhs;
295  }
296 
304  inline bool
306  const PixelType& rhs)
307  {
308  return lhs != static_cast<PixelType::enum_value>(rhs);
309  }
310 
318  inline bool
319  operator!= (const PixelType& lhs,
320  const std::string& rhs)
321  {
322  return static_cast<const std::string&>(lhs) != rhs;
323  }
324 
332  inline bool
333  operator!= (const std::string& lhs,
334  const PixelType& rhs)
335  {
336  return lhs != static_cast<const std::string&>(rhs);
337  }
338 
346  template<class charT, class traits>
347  inline std::basic_ostream<charT,traits>&
348  operator<< (std::basic_ostream<charT,traits>& os,
349  const PixelType& enumeration)
350  {
351  return os << static_cast<const std::string&>(enumeration);
352  }
353 
361  template<class charT, class traits>
362  inline std::basic_istream<charT,traits>&
363  operator>> (std::basic_istream<charT,traits>& is,
364  PixelType& enumeration)
365  {
366  std::string value;
367  is >> value;
368  if (is)
369  {
370  try
371  {
372  enumeration = PixelType(value, false);
373  }
374  catch (const EnumerationException& e)
375  {
376  is.setstate(std::ios::failbit);
377  }
378  }
379 
380  return is;
381  }
382 
383  }
384  }
385  }
386 }
387 
388 #endif // OME_XML_MODEL_ENUMS_PIXELTYPE_H
389 
390 /*
391  * Local Variables:
392  * mode:C++
393  * End:
394  */
uint32
Definition: PixelType.h:87
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:381
uint8
Definition: PixelType.h:83
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:295
PixelType(enum_value value)
Construct a PixelType enumeration by an enumeration value.
Definition: PixelType.cpp:147
bit
Definition: PixelType.h:91
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
int8
Definition: PixelType.h:77
std::map< std::string, PixelType::enum_value > string_map_type
String map type.
Definition: PixelType.h:165
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: PixelType.cpp:74
static const value_map_type value_map
Mapping of enumeration value to name.
Definition: PixelType.h:196
static const string_map_type lowercase_string_map
Mapping of lowercase enumeration name to value.
Definition: PixelType.h:194
enum_value
Enumeration values.
Definition: PixelType.h:74
int16
Definition: PixelType.h:79
uint16
Definition: PixelType.h:85
float
Definition: PixelType.h:89
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
const std::string * name
Enumeration name.
Definition: PixelType.h:189
enum_value value
Enumeration value.
Definition: PixelType.h:187
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: PixelType.cpp:68
complex
Definition: PixelType.h:95
std::map< PixelType::enum_value, std::string > value_map_type
Value map type.
Definition: PixelType.h:167
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
double
Definition: PixelType.h:93
PixelType enumeration.
Definition: PixelType.h:70
static const string_map_type string_map
Mapping of enumeration name to value.
Definition: PixelType.h:192
int32
Definition: PixelType.h:81
double-complex
Definition: PixelType.h:97
Boost.Log compatibility.
PixelType & operator=(const PixelType &rhs)
Assignment operator.
Definition: PixelType.h:135
Xerces-C modern C++ wrapper.
Definition: Base.h:53