ome-xml  5.2.0
Medium.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_MEDIUM_H
47 #define OME_XML_MODEL_ENUMS_MEDIUM_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 Medium enumeration.
58 #define OME_XML_MODEL_ENUMS_MEDIUM_VALUES (AIR)(OIL)(WATER)(GLYCEROL)(OTHER)
59 
60 namespace ome
61 {
62  namespace xml
63  {
64  namespace model
65  {
66  namespace enums
67  {
68 
72  class Medium
73  {
74  public:
77  {
79  AIR,
81  OIL,
88  };
89 
96 
111  Medium (const std::string& name, bool strict = true);
112 
118  Medium (const Medium& original);
119 
124  inline Medium&
125  operator= (const Medium& rhs)
126  {
127  this->value = rhs.value;
128  this->name = rhs.name;
129  return *this;
130  }
131 
137  inline
138  operator enum_value () const
139  {
140  return this->value;
141  }
142 
148  inline
149  operator const std::string& () const
150  {
151  return *this->name;
152  }
153 
155  typedef std::map<std::string, Medium::enum_value> string_map_type;
157  typedef std::map<Medium::enum_value, std::string> value_map_type;
158 
164  static const string_map_type&
165  strings();
166 
172  static const value_map_type&
173  values();
174 
175  private:
181  static const string_map_type&
183 
187  const std::string *name;
188  };
189 
197  inline bool
198  operator== (const Medium& lhs,
199  const Medium& rhs)
200  {
201  return static_cast<Medium::enum_value>(lhs) == static_cast<Medium::enum_value>(rhs);
202  }
203 
211  inline bool
212  operator== (const Medium& lhs,
213  const Medium::enum_value& rhs)
214  {
215  return static_cast<Medium::enum_value>(lhs) == rhs;
216  }
217 
225  inline bool
227  const Medium& rhs)
228  {
229  return lhs == static_cast<Medium::enum_value>(rhs);
230  }
231 
239  inline bool
240  operator== (const Medium& lhs,
241  const std::string& rhs)
242  {
243  return static_cast<const std::string&>(lhs) == rhs;
244  }
245 
253  inline bool
254  operator== (const std::string& lhs,
255  const Medium& rhs)
256  {
257  return lhs == static_cast<const std::string&>(rhs);
258  }
259 
267  inline bool
268  operator!= (const Medium& lhs,
269  const Medium& rhs)
270  {
271  return static_cast<Medium::enum_value>(lhs) != static_cast<Medium::enum_value>(rhs);
272  }
273 
281  inline bool
282  operator!= (const Medium& lhs,
283  const Medium::enum_value& rhs)
284  {
285  return static_cast<Medium::enum_value>(lhs) != rhs;
286  }
287 
295  inline bool
297  const Medium& rhs)
298  {
299  return lhs != static_cast<Medium::enum_value>(rhs);
300  }
301 
309  inline bool
310  operator!= (const Medium& lhs,
311  const std::string& rhs)
312  {
313  return static_cast<const std::string&>(lhs) != rhs;
314  }
315 
323  inline bool
324  operator!= (const std::string& lhs,
325  const Medium& rhs)
326  {
327  return lhs != static_cast<const std::string&>(rhs);
328  }
329 
337  template<class charT, class traits>
338  inline std::basic_ostream<charT,traits>&
339  operator<< (std::basic_ostream<charT,traits>& os,
340  const Medium& enumeration)
341  {
342  return os << static_cast<const std::string&>(enumeration);
343  }
344 
352  template<class charT, class traits>
353  inline std::basic_istream<charT,traits>&
354  operator>> (std::basic_istream<charT,traits>& is,
355  Medium& enumeration)
356  {
357  std::string value;
358  is >> value;
359  if (is)
360  {
361  try
362  {
363  enumeration = Medium(value, false);
364  }
365  catch (const EnumerationException&)
366  {
367  is.setstate(std::ios::failbit);
368  }
369  }
370 
371  return is;
372  }
373 
374  }
375  }
376  }
377 }
378 
379 #endif // OME_XML_MODEL_ENUMS_MEDIUM_H
380 
381 /*
382  * Local Variables:
383  * mode:C++
384  * End:
385  */
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
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: Medium.cpp:189
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
std::map< Medium::enum_value, std::string > value_map_type
Value map type.
Definition: Medium.h:157
enum_value
Enumeration values.
Definition: Medium.h:76
enum_value value
Enumeration value.
Definition: Medium.h:185
Oil.
Definition: Medium.h:81
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Medium.cpp:171
Medium(enum_value value)
Construct a Medium enumeration by an enumeration value.
Definition: Medium.cpp:75
Medium & operator=(const Medium &rhs)
Assignment operator.
Definition: Medium.h:125
Open Microscopy Environment C++ implementation.
Glycerol.
Definition: Medium.h:85
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:228
const std::string * name
Enumeration name.
Definition: Medium.h:187
Water.
Definition: Medium.h:83
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Medium.cpp:153
std::map< std::string, Medium::enum_value > string_map_type
String map type.
Definition: Medium.h:155
Other.
Definition: Medium.h:87
Medium enumeration.
Definition: Medium.h:72
Air.
Definition: Medium.h:79