bioformats  5.1.3
Correction.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_CORRECTION_H
47 #define OME_XML_MODEL_ENUMS_CORRECTION_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 Correction
71  {
72  public:
75  {
77  UV,
93  FL,
106  };
107 
114 
129  Correction (const std::string& name, bool strict = true);
130 
136  Correction (const Correction& original);
137 
142  inline Correction&
143  operator= (const Correction& rhs)
144  {
145  this->value = rhs.value;
146  this->name = rhs.name;
147  return *this;
148  }
149 
155  inline
156  operator enum_value () const
157  {
158  return this->value;
159  }
160 
166  inline
167  operator const std::string& () const
168  {
169  return *this->name;
170  }
171 
173  typedef std::map<std::string, Correction::enum_value> string_map_type;
175  typedef std::map<Correction::enum_value, std::string> value_map_type;
176 
182  static const string_map_type&
183  strings();
184 
190  static const value_map_type&
191  values();
192 
193  private:
197  const std::string *name;
198 
200  static const string_map_type string_map;
202  static const string_map_type lowercase_string_map;
204  static const value_map_type value_map;
205  };
206 
214  inline bool
216  const Correction& rhs)
217  {
218  return static_cast<Correction::enum_value>(lhs) == static_cast<Correction::enum_value>(rhs);
219  }
220 
228  inline bool
230  const Correction::enum_value& rhs)
231  {
232  return static_cast<Correction::enum_value>(lhs) == rhs;
233  }
234 
242  inline bool
244  const Correction& rhs)
245  {
246  return lhs == static_cast<Correction::enum_value>(rhs);
247  }
248 
256  inline bool
258  const std::string& rhs)
259  {
260  return static_cast<const std::string&>(lhs) == rhs;
261  }
262 
270  inline bool
271  operator== (const std::string& lhs,
272  const Correction& rhs)
273  {
274  return lhs == static_cast<const std::string&>(rhs);
275  }
276 
284  inline bool
286  const Correction& rhs)
287  {
288  return static_cast<Correction::enum_value>(lhs) != static_cast<Correction::enum_value>(rhs);
289  }
290 
298  inline bool
300  const Correction::enum_value& rhs)
301  {
302  return static_cast<Correction::enum_value>(lhs) != rhs;
303  }
304 
312  inline bool
314  const Correction& rhs)
315  {
316  return lhs != static_cast<Correction::enum_value>(rhs);
317  }
318 
326  inline bool
328  const std::string& rhs)
329  {
330  return static_cast<const std::string&>(lhs) != rhs;
331  }
332 
340  inline bool
341  operator!= (const std::string& lhs,
342  const Correction& rhs)
343  {
344  return lhs != static_cast<const std::string&>(rhs);
345  }
346 
354  template<class charT, class traits>
355  inline std::basic_ostream<charT,traits>&
356  operator<< (std::basic_ostream<charT,traits>& os,
357  const Correction& enumeration)
358  {
359  return os << static_cast<const std::string&>(enumeration);
360  }
361 
369  template<class charT, class traits>
370  inline std::basic_istream<charT,traits>&
371  operator>> (std::basic_istream<charT,traits>& is,
372  Correction& enumeration)
373  {
374  std::string value;
375  is >> value;
376  if (is)
377  {
378  try
379  {
380  enumeration = Correction(value, false);
381  }
382  catch (const EnumerationException& e)
383  {
384  is.setstate(std::ios::failbit);
385  }
386  }
387 
388  return is;
389  }
390 
391  }
392  }
393  }
394 }
395 
396 #endif // OME_XML_MODEL_ENUMS_CORRECTION_H
397 
398 /*
399  * Local Variables:
400  * mode:C++
401  * End:
402  */
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
Correction enumeration.
Definition: Correction.h:70
Correction(enum_value value)
Construct a Correction enumeration by an enumeration value.
Definition: Correction.cpp:159
Fluotar.
Definition: Correction.h:99
PlanNeofluar.
Definition: Correction.h:103
std::map< std::string, Correction::enum_value > string_map_type
String map type.
Definition: Correction.h:173
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
Neofluar.
Definition: Correction.h:97
Other.
Definition: Correction.h:105
static const string_map_type lowercase_string_map
Mapping of lowercase enumeration name to value.
Definition: Correction.h:202
enum_value
Enumeration values.
Definition: Correction.h:74
Achro.
Definition: Correction.h:87
enum_value value
Enumeration value.
Definition: Correction.h:195
PlanApo.
Definition: Correction.h:79
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Correction.cpp:68
VioletCorrected.
Definition: Correction.h:85
SuperFluor.
Definition: Correction.h:83
Fl.
Definition: Correction.h:93
const std::string * name
Enumeration name.
Definition: Correction.h:197
Apo.
Definition: Correction.h:101
std::map< Correction::enum_value, std::string > value_map_type
Value map type.
Definition: Correction.h:175
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
Correction & operator=(const Correction &rhs)
Assignment operator.
Definition: Correction.h:143
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
static const value_map_type value_map
Mapping of enumeration value to name.
Definition: Correction.h:204
Fluar.
Definition: Correction.h:95
UV.
Definition: Correction.h:77
static const string_map_type string_map
Mapping of enumeration name to value.
Definition: Correction.h:200
Fluor.
Definition: Correction.h:91
Achromat.
Definition: Correction.h:89
PlanFluor.
Definition: Correction.h:81
Boost.Log compatibility.
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Correction.cpp:74
Xerces-C modern C++ wrapper.
Definition: Base.h:53