ome-xml  5.2.2
LaserType.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_LASERTYPE_H
47 #define OME_XML_MODEL_ENUMS_LASERTYPE_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 LaserType enumeration.
58 #define OME_XML_MODEL_ENUMS_LASERTYPE_VALUES (EXCIMER)(GAS)(METALVAPOR)(SOLIDSTATE)(DYE)(SEMICONDUCTOR)(FREEELECTRON)(OTHER)
59 
60 namespace ome
61 {
62  namespace xml
63  {
64  namespace model
65  {
66  namespace enums
67  {
68 
72  class LaserType
73  {
74  public:
77  {
81  GAS,
87  DYE,
94  };
95 
102 
117  LaserType (const std::string& name, bool strict = true);
118 
124  LaserType (const LaserType& original);
125 
130  inline LaserType&
131  operator= (const LaserType& rhs)
132  {
133  this->value = rhs.value;
134  this->name = rhs.name;
135  return *this;
136  }
137 
143  inline
144  operator enum_value () const
145  {
146  return this->value;
147  }
148 
154  inline
155  operator const std::string& () const
156  {
157  return *this->name;
158  }
159 
161  typedef std::map<std::string, LaserType::enum_value> string_map_type;
163  typedef std::map<LaserType::enum_value, std::string> value_map_type;
164 
170  static const string_map_type&
171  strings();
172 
178  static const value_map_type&
179  values();
180 
181  private:
187  static const string_map_type&
189 
193  const std::string *name;
194  };
195 
203  inline bool
204  operator== (const LaserType& lhs,
205  const LaserType& rhs)
206  {
207  return static_cast<LaserType::enum_value>(lhs) == static_cast<LaserType::enum_value>(rhs);
208  }
209 
217  inline bool
218  operator== (const LaserType& lhs,
219  const LaserType::enum_value& rhs)
220  {
221  return static_cast<LaserType::enum_value>(lhs) == rhs;
222  }
223 
231  inline bool
233  const LaserType& rhs)
234  {
235  return lhs == static_cast<LaserType::enum_value>(rhs);
236  }
237 
245  inline bool
246  operator== (const LaserType& lhs,
247  const std::string& rhs)
248  {
249  return static_cast<const std::string&>(lhs) == rhs;
250  }
251 
259  inline bool
260  operator== (const std::string& lhs,
261  const LaserType& rhs)
262  {
263  return lhs == static_cast<const std::string&>(rhs);
264  }
265 
273  inline bool
274  operator!= (const LaserType& lhs,
275  const LaserType& rhs)
276  {
277  return static_cast<LaserType::enum_value>(lhs) != static_cast<LaserType::enum_value>(rhs);
278  }
279 
287  inline bool
288  operator!= (const LaserType& lhs,
289  const LaserType::enum_value& rhs)
290  {
291  return static_cast<LaserType::enum_value>(lhs) != rhs;
292  }
293 
301  inline bool
303  const LaserType& rhs)
304  {
305  return lhs != static_cast<LaserType::enum_value>(rhs);
306  }
307 
315  inline bool
316  operator!= (const LaserType& lhs,
317  const std::string& rhs)
318  {
319  return static_cast<const std::string&>(lhs) != rhs;
320  }
321 
329  inline bool
330  operator!= (const std::string& lhs,
331  const LaserType& rhs)
332  {
333  return lhs != static_cast<const std::string&>(rhs);
334  }
335 
343  template<class charT, class traits>
344  inline std::basic_ostream<charT,traits>&
345  operator<< (std::basic_ostream<charT,traits>& os,
346  const LaserType& enumeration)
347  {
348  return os << static_cast<const std::string&>(enumeration);
349  }
350 
358  template<class charT, class traits>
359  inline std::basic_istream<charT,traits>&
360  operator>> (std::basic_istream<charT,traits>& is,
361  LaserType& enumeration)
362  {
363  std::string value;
364  is >> value;
365  if (is)
366  {
367  try
368  {
369  enumeration = LaserType(value, false);
370  }
371  catch (const EnumerationException&)
372  {
373  is.setstate(std::ios::failbit);
374  }
375  }
376 
377  return is;
378  }
379 
380  }
381  }
382  }
383 }
384 
385 #endif // OME_XML_MODEL_ENUMS_LASERTYPE_H
386 
387 /*
388  * Local Variables:
389  * mode:C++
390  * End:
391  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:384
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:298
MetalVapor.
Definition: LaserType.h:83
FreeElectron.
Definition: LaserType.h:91
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
enum_value value
Enumeration value.
Definition: LaserType.h:191
LaserType & operator=(const LaserType &rhs)
Assignment operator.
Definition: LaserType.h:131
const std::string * name
Enumeration name.
Definition: LaserType.h:193
std::map< std::string, LaserType::enum_value > string_map_type
String map type.
Definition: LaserType.h:161
Dye.
Definition: LaserType.h:87
LaserType(enum_value value)
Construct a LaserType enumeration by an enumeration value.
Definition: LaserType.cpp:75
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: LaserType.cpp:174
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: LaserType.cpp:153
Gas.
Definition: LaserType.h:81
Open Microscopy Environment C++ implementation.
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:228
enum_value
Enumeration values.
Definition: LaserType.h:76
LaserType enumeration.
Definition: LaserType.h:72
Excimer.
Definition: LaserType.h:79
Semiconductor.
Definition: LaserType.h:89
std::map< LaserType::enum_value, std::string > value_map_type
Value map type.
Definition: LaserType.h:163
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: LaserType.cpp:195
SolidState.
Definition: LaserType.h:85
Other.
Definition: LaserType.h:93