bioformats  5.1.3
LaserType.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_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 
58 namespace ome
59 {
60  namespace xml
61  {
62  namespace model
63  {
64  namespace enums
65  {
66 
70  class LaserType
71  {
72  public:
75  {
79  GAS,
85  DYE,
92  };
93 
100 
115  LaserType (const std::string& name, bool strict = true);
116 
122  LaserType (const LaserType& original);
123 
128  inline LaserType&
129  operator= (const LaserType& rhs)
130  {
131  this->value = rhs.value;
132  this->name = rhs.name;
133  return *this;
134  }
135 
141  inline
142  operator enum_value () const
143  {
144  return this->value;
145  }
146 
152  inline
153  operator const std::string& () const
154  {
155  return *this->name;
156  }
157 
159  typedef std::map<std::string, LaserType::enum_value> string_map_type;
161  typedef std::map<LaserType::enum_value, std::string> value_map_type;
162 
168  static const string_map_type&
169  strings();
170 
176  static const value_map_type&
177  values();
178 
179  private:
183  const std::string *name;
184 
186  static const string_map_type string_map;
188  static const string_map_type lowercase_string_map;
190  static const value_map_type value_map;
191  };
192 
200  inline bool
201  operator== (const LaserType& lhs,
202  const LaserType& rhs)
203  {
204  return static_cast<LaserType::enum_value>(lhs) == static_cast<LaserType::enum_value>(rhs);
205  }
206 
214  inline bool
215  operator== (const LaserType& lhs,
216  const LaserType::enum_value& rhs)
217  {
218  return static_cast<LaserType::enum_value>(lhs) == rhs;
219  }
220 
228  inline bool
230  const LaserType& rhs)
231  {
232  return lhs == static_cast<LaserType::enum_value>(rhs);
233  }
234 
242  inline bool
243  operator== (const LaserType& lhs,
244  const std::string& rhs)
245  {
246  return static_cast<const std::string&>(lhs) == rhs;
247  }
248 
256  inline bool
257  operator== (const std::string& lhs,
258  const LaserType& rhs)
259  {
260  return lhs == static_cast<const std::string&>(rhs);
261  }
262 
270  inline bool
271  operator!= (const LaserType& lhs,
272  const LaserType& rhs)
273  {
274  return static_cast<LaserType::enum_value>(lhs) != static_cast<LaserType::enum_value>(rhs);
275  }
276 
284  inline bool
285  operator!= (const LaserType& lhs,
286  const LaserType::enum_value& rhs)
287  {
288  return static_cast<LaserType::enum_value>(lhs) != rhs;
289  }
290 
298  inline bool
300  const LaserType& rhs)
301  {
302  return lhs != static_cast<LaserType::enum_value>(rhs);
303  }
304 
312  inline bool
313  operator!= (const LaserType& lhs,
314  const std::string& rhs)
315  {
316  return static_cast<const std::string&>(lhs) != rhs;
317  }
318 
326  inline bool
327  operator!= (const std::string& lhs,
328  const LaserType& rhs)
329  {
330  return lhs != static_cast<const std::string&>(rhs);
331  }
332 
340  template<class charT, class traits>
341  inline std::basic_ostream<charT,traits>&
342  operator<< (std::basic_ostream<charT,traits>& os,
343  const LaserType& enumeration)
344  {
345  return os << static_cast<const std::string&>(enumeration);
346  }
347 
355  template<class charT, class traits>
356  inline std::basic_istream<charT,traits>&
357  operator>> (std::basic_istream<charT,traits>& is,
358  LaserType& enumeration)
359  {
360  std::string value;
361  is >> value;
362  if (is)
363  {
364  try
365  {
366  enumeration = LaserType(value, false);
367  }
368  catch (const EnumerationException& e)
369  {
370  is.setstate(std::ios::failbit);
371  }
372  }
373 
374  return is;
375  }
376 
377  }
378  }
379  }
380 }
381 
382 #endif // OME_XML_MODEL_ENUMS_LASERTYPE_H
383 
384 /*
385  * Local Variables:
386  * mode:C++
387  * End:
388  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:381
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:295
MetalVapor.
Definition: LaserType.h:81
FreeElectron.
Definition: LaserType.h:89
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
enum_value value
Enumeration value.
Definition: LaserType.h:181
static const string_map_type string_map
Mapping of enumeration name to value.
Definition: LaserType.h:186
LaserType & operator=(const LaserType &rhs)
Assignment operator.
Definition: LaserType.h:129
const std::string * name
Enumeration name.
Definition: LaserType.h:183
std::map< std::string, LaserType::enum_value > string_map_type
String map type.
Definition: LaserType.h:159
Dye.
Definition: LaserType.h:85
LaserType(enum_value value)
Construct a LaserType enumeration by an enumeration value.
Definition: LaserType.cpp:138
static const value_map_type value_map
Mapping of enumeration value to name.
Definition: LaserType.h:190
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: LaserType.cpp:74
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: LaserType.cpp:68
Gas.
Definition: LaserType.h:79
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
enum_value
Enumeration values.
Definition: LaserType.h:74
LaserType enumeration.
Definition: LaserType.h:70
Excimer.
Definition: LaserType.h:77
Semiconductor.
Definition: LaserType.h:87
std::map< LaserType::enum_value, std::string > value_map_type
Value map type.
Definition: LaserType.h:161
Boost.Log compatibility.
SolidState.
Definition: LaserType.h:83
Other.
Definition: LaserType.h:91
static const string_map_type lowercase_string_map
Mapping of lowercase enumeration name to value.
Definition: LaserType.h:188
Xerces-C modern C++ wrapper.
Definition: Base.h:53