ome-xml  5.2.0
PixelType.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_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 // All values in the PixelType enumeration.
58 #define OME_XML_MODEL_ENUMS_PIXELTYPE_VALUES (INT8)(INT16)(INT32)(UINT8)(UINT16)(UINT32)(FLOAT)(BIT)(DOUBLE)(COMPLEX)(DOUBLECOMPLEX)
59 
60 namespace ome
61 {
62  namespace xml
63  {
64  namespace model
65  {
66  namespace enums
67  {
68 
72  class PixelType
73  {
74  public:
77  {
93  BIT,
100  };
101 
108 
123  PixelType (const std::string& name, bool strict = true);
124 
130  PixelType (const PixelType& original);
131 
136  inline PixelType&
137  operator= (const PixelType& rhs)
138  {
139  this->value = rhs.value;
140  this->name = rhs.name;
141  return *this;
142  }
143 
149  inline
150  operator enum_value () const
151  {
152  return this->value;
153  }
154 
160  inline
161  operator const std::string& () const
162  {
163  return *this->name;
164  }
165 
167  typedef std::map<std::string, PixelType::enum_value> string_map_type;
169  typedef std::map<PixelType::enum_value, std::string> value_map_type;
170 
176  static const string_map_type&
177  strings();
178 
184  static const value_map_type&
185  values();
186 
187  private:
193  static const string_map_type&
195 
199  const std::string *name;
200  };
201 
209  inline bool
210  operator== (const PixelType& lhs,
211  const PixelType& rhs)
212  {
213  return static_cast<PixelType::enum_value>(lhs) == static_cast<PixelType::enum_value>(rhs);
214  }
215 
223  inline bool
224  operator== (const PixelType& lhs,
225  const PixelType::enum_value& rhs)
226  {
227  return static_cast<PixelType::enum_value>(lhs) == rhs;
228  }
229 
237  inline bool
239  const PixelType& rhs)
240  {
241  return lhs == static_cast<PixelType::enum_value>(rhs);
242  }
243 
251  inline bool
252  operator== (const PixelType& lhs,
253  const std::string& rhs)
254  {
255  return static_cast<const std::string&>(lhs) == rhs;
256  }
257 
265  inline bool
266  operator== (const std::string& lhs,
267  const PixelType& rhs)
268  {
269  return lhs == static_cast<const std::string&>(rhs);
270  }
271 
279  inline bool
280  operator!= (const PixelType& lhs,
281  const PixelType& rhs)
282  {
283  return static_cast<PixelType::enum_value>(lhs) != static_cast<PixelType::enum_value>(rhs);
284  }
285 
293  inline bool
294  operator!= (const PixelType& lhs,
295  const PixelType::enum_value& rhs)
296  {
297  return static_cast<PixelType::enum_value>(lhs) != rhs;
298  }
299 
307  inline bool
309  const PixelType& rhs)
310  {
311  return lhs != static_cast<PixelType::enum_value>(rhs);
312  }
313 
321  inline bool
322  operator!= (const PixelType& lhs,
323  const std::string& rhs)
324  {
325  return static_cast<const std::string&>(lhs) != rhs;
326  }
327 
335  inline bool
336  operator!= (const std::string& lhs,
337  const PixelType& rhs)
338  {
339  return lhs != static_cast<const std::string&>(rhs);
340  }
341 
349  template<class charT, class traits>
350  inline std::basic_ostream<charT,traits>&
351  operator<< (std::basic_ostream<charT,traits>& os,
352  const PixelType& enumeration)
353  {
354  return os << static_cast<const std::string&>(enumeration);
355  }
356 
364  template<class charT, class traits>
365  inline std::basic_istream<charT,traits>&
366  operator>> (std::basic_istream<charT,traits>& is,
367  PixelType& enumeration)
368  {
369  std::string value;
370  is >> value;
371  if (is)
372  {
373  try
374  {
375  enumeration = PixelType(value, false);
376  }
377  catch (const EnumerationException&)
378  {
379  is.setstate(std::ios::failbit);
380  }
381  }
382 
383  return is;
384  }
385 
386  }
387  }
388  }
389 }
390 
391 #endif // OME_XML_MODEL_ENUMS_PIXELTYPE_H
392 
393 /*
394  * Local Variables:
395  * mode:C++
396  * End:
397  */
uint32
Definition: PixelType.h:89
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:384
uint8
Definition: PixelType.h:85
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:298
PixelType(enum_value value)
Construct a PixelType enumeration by an enumeration value.
Definition: PixelType.cpp:75
bit
Definition: PixelType.h:93
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
int8
Definition: PixelType.h:79
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: PixelType.cpp:186
std::map< std::string, PixelType::enum_value > string_map_type
String map type.
Definition: PixelType.h:167
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: PixelType.cpp:162
enum_value
Enumeration values.
Definition: PixelType.h:76
int16
Definition: PixelType.h:81
uint16
Definition: PixelType.h:87
float
Definition: PixelType.h:91
Open Microscopy Environment C++ implementation.
const std::string * name
Enumeration name.
Definition: PixelType.h:199
enum_value value
Enumeration value.
Definition: PixelType.h:197
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: PixelType.cpp:138
complex
Definition: PixelType.h:97
std::map< PixelType::enum_value, std::string > value_map_type
Value map type.
Definition: PixelType.h:169
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:228
double
Definition: PixelType.h:95
PixelType enumeration.
Definition: PixelType.h:72
int32
Definition: PixelType.h:83
double-complex
Definition: PixelType.h:99
PixelType & operator=(const PixelType &rhs)
Assignment operator.
Definition: PixelType.h:137