bioformats  5.1.2
Immersion.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_IMMERSION_H
47 #define OME_XML_MODEL_ENUMS_IMMERSION_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 Immersion
71  {
72  public:
75  {
77  OIL,
83  AIR,
90  };
91 
98 
113  Immersion (const std::string& name, bool strict = true);
114 
120  Immersion (const Immersion& original);
121 
126  inline Immersion&
127  operator= (const Immersion& rhs)
128  {
129  this->value = rhs.value;
130  this->name = rhs.name;
131  return *this;
132  }
133 
139  inline
140  operator enum_value () const
141  {
142  return this->value;
143  }
144 
150  inline
151  operator const std::string& () const
152  {
153  return *this->name;
154  }
155 
157  typedef std::map<std::string, Immersion::enum_value> string_map_type;
159  typedef std::map<Immersion::enum_value, std::string> value_map_type;
160 
166  static const string_map_type&
167  strings();
168 
174  static const value_map_type&
175  values();
176 
177  private:
181  const std::string *name;
182 
184  static const string_map_type string_map;
186  static const string_map_type lowercase_string_map;
188  static const value_map_type value_map;
189  };
190 
198  inline bool
199  operator== (const Immersion& lhs,
200  const Immersion& rhs)
201  {
202  return static_cast<Immersion::enum_value>(lhs) == static_cast<Immersion::enum_value>(rhs);
203  }
204 
212  inline bool
213  operator== (const Immersion& lhs,
214  const Immersion::enum_value& rhs)
215  {
216  return static_cast<Immersion::enum_value>(lhs) == rhs;
217  }
218 
226  inline bool
228  const Immersion& rhs)
229  {
230  return lhs == static_cast<Immersion::enum_value>(rhs);
231  }
232 
240  inline bool
241  operator== (const Immersion& lhs,
242  const std::string& rhs)
243  {
244  return static_cast<const std::string&>(lhs) == rhs;
245  }
246 
254  inline bool
255  operator== (const std::string& lhs,
256  const Immersion& rhs)
257  {
258  return lhs == static_cast<const std::string&>(rhs);
259  }
260 
268  inline bool
269  operator!= (const Immersion& lhs,
270  const Immersion& rhs)
271  {
272  return static_cast<Immersion::enum_value>(lhs) != static_cast<Immersion::enum_value>(rhs);
273  }
274 
282  inline bool
283  operator!= (const Immersion& lhs,
284  const Immersion::enum_value& rhs)
285  {
286  return static_cast<Immersion::enum_value>(lhs) != rhs;
287  }
288 
296  inline bool
298  const Immersion& rhs)
299  {
300  return lhs != static_cast<Immersion::enum_value>(rhs);
301  }
302 
310  inline bool
311  operator!= (const Immersion& lhs,
312  const std::string& rhs)
313  {
314  return static_cast<const std::string&>(lhs) != rhs;
315  }
316 
324  inline bool
325  operator!= (const std::string& lhs,
326  const Immersion& rhs)
327  {
328  return lhs != static_cast<const std::string&>(rhs);
329  }
330 
338  template<class charT, class traits>
339  inline std::basic_ostream<charT,traits>&
340  operator<< (std::basic_ostream<charT,traits>& os,
341  const Immersion& enumeration)
342  {
343  return os << static_cast<const std::string&>(enumeration);
344  }
345 
353  template<class charT, class traits>
354  inline std::basic_istream<charT,traits>&
355  operator>> (std::basic_istream<charT,traits>& is,
356  Immersion& enumeration)
357  {
358  std::string value;
359  is >> value;
360  if (is)
361  {
362  try
363  {
364  enumeration = Immersion(value, false);
365  }
366  catch (const EnumerationException& e)
367  {
368  is.setstate(std::ios::failbit);
369  }
370  }
371 
372  return is;
373  }
374 
375  }
376  }
377  }
378 }
379 
380 #endif // OME_XML_MODEL_ENUMS_IMMERSION_H
381 
382 /*
383  * Local Variables:
384  * mode:C++
385  * End:
386  */
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
enum_value value
Enumeration value.
Definition: Immersion.h:179
Air.
Definition: Immersion.h:83
Immersion(enum_value value)
Construct a Immersion enumeration by an enumeration value.
Definition: Immersion.cpp:135
Other.
Definition: Immersion.h:89
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
static const string_map_type string_map
Mapping of enumeration name to value.
Definition: Immersion.h:184
std::map< std::string, Immersion::enum_value > string_map_type
String map type.
Definition: Immersion.h:157
static const string_map_type lowercase_string_map
Mapping of lowercase enumeration name to value.
Definition: Immersion.h:186
Immersion enumeration.
Definition: Immersion.h:70
std::map< Immersion::enum_value, std::string > value_map_type
Value map type.
Definition: Immersion.h:159
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Immersion.cpp:74
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
WaterDipping.
Definition: Immersion.h:81
Glycerol.
Definition: Immersion.h:87
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Immersion.cpp:68
Immersion & operator=(const Immersion &rhs)
Assignment operator.
Definition: Immersion.h:127
const std::string * name
Enumeration name.
Definition: Immersion.h:181
Oil.
Definition: Immersion.h:77
enum_value
Enumeration values.
Definition: Immersion.h:74
static const value_map_type value_map
Mapping of enumeration value to name.
Definition: Immersion.h:188
Boost.Log compatibility.
Multi.
Definition: Immersion.h:85
Water.
Definition: Immersion.h:79
Xerces-C modern C++ wrapper.
Definition: Base.h:53