bioformats  5.1.3
ContrastMethod.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_CONTRASTMETHOD_H
47 #define OME_XML_MODEL_ENUMS_CONTRASTMETHOD_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 
71  {
72  public:
75  {
81  DIC,
94  };
95 
102 
117  ContrastMethod (const std::string& name, bool strict = true);
118 
124  ContrastMethod (const ContrastMethod& original);
125 
130  inline ContrastMethod&
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, ContrastMethod::enum_value> string_map_type;
163  typedef std::map<ContrastMethod::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:
185  const std::string *name;
186 
188  static const string_map_type string_map;
190  static const string_map_type lowercase_string_map;
192  static const value_map_type value_map;
193  };
194 
202  inline bool
204  const ContrastMethod& rhs)
205  {
206  return static_cast<ContrastMethod::enum_value>(lhs) == static_cast<ContrastMethod::enum_value>(rhs);
207  }
208 
216  inline bool
218  const ContrastMethod::enum_value& rhs)
219  {
220  return static_cast<ContrastMethod::enum_value>(lhs) == rhs;
221  }
222 
230  inline bool
232  const ContrastMethod& rhs)
233  {
234  return lhs == static_cast<ContrastMethod::enum_value>(rhs);
235  }
236 
244  inline bool
246  const std::string& rhs)
247  {
248  return static_cast<const std::string&>(lhs) == rhs;
249  }
250 
258  inline bool
259  operator== (const std::string& lhs,
260  const ContrastMethod& rhs)
261  {
262  return lhs == static_cast<const std::string&>(rhs);
263  }
264 
272  inline bool
274  const ContrastMethod& rhs)
275  {
276  return static_cast<ContrastMethod::enum_value>(lhs) != static_cast<ContrastMethod::enum_value>(rhs);
277  }
278 
286  inline bool
288  const ContrastMethod::enum_value& rhs)
289  {
290  return static_cast<ContrastMethod::enum_value>(lhs) != rhs;
291  }
292 
300  inline bool
302  const ContrastMethod& rhs)
303  {
304  return lhs != static_cast<ContrastMethod::enum_value>(rhs);
305  }
306 
314  inline bool
316  const std::string& rhs)
317  {
318  return static_cast<const std::string&>(lhs) != rhs;
319  }
320 
328  inline bool
329  operator!= (const std::string& lhs,
330  const ContrastMethod& rhs)
331  {
332  return lhs != static_cast<const std::string&>(rhs);
333  }
334 
342  template<class charT, class traits>
343  inline std::basic_ostream<charT,traits>&
344  operator<< (std::basic_ostream<charT,traits>& os,
345  const ContrastMethod& enumeration)
346  {
347  return os << static_cast<const std::string&>(enumeration);
348  }
349 
357  template<class charT, class traits>
358  inline std::basic_istream<charT,traits>&
359  operator>> (std::basic_istream<charT,traits>& is,
360  ContrastMethod& enumeration)
361  {
362  std::string value;
363  is >> value;
364  if (is)
365  {
366  try
367  {
368  enumeration = ContrastMethod(value, false);
369  }
370  catch (const EnumerationException& e)
371  {
372  is.setstate(std::ios::failbit);
373  }
374  }
375 
376  return is;
377  }
378 
379  }
380  }
381  }
382 }
383 
384 #endif // OME_XML_MODEL_ENUMS_CONTRASTMETHOD_H
385 
386 /*
387  * Local Variables:
388  * mode:C++
389  * End:
390  */
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
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
Darkfield.
Definition: ContrastMethod.h:89
Brightfield.
Definition: ContrastMethod.h:77
Phase.
Definition: ContrastMethod.h:79
std::map< ContrastMethod::enum_value, std::string > value_map_type
Value map type.
Definition: ContrastMethod.h:163
static const string_map_type string_map
Mapping of enumeration name to value.
Definition: ContrastMethod.h:188
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: ContrastMethod.cpp:68
ObliqueIllumination.
Definition: ContrastMethod.h:85
Other.
Definition: ContrastMethod.h:93
DIC.
Definition: ContrastMethod.h:81
ContrastMethod enumeration.
Definition: ContrastMethod.h:70
ContrastMethod & operator=(const ContrastMethod &rhs)
Assignment operator.
Definition: ContrastMethod.h:131
static const value_map_type value_map
Mapping of enumeration value to name.
Definition: ContrastMethod.h:192
PolarizedLight.
Definition: ContrastMethod.h:87
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
std::map< std::string, ContrastMethod::enum_value > string_map_type
String map type.
Definition: ContrastMethod.h:161
enum_value
Enumeration values.
Definition: ContrastMethod.h:74
static const string_map_type lowercase_string_map
Mapping of lowercase enumeration name to value.
Definition: ContrastMethod.h:190
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
HoffmanModulation.
Definition: ContrastMethod.h:83
enum_value value
Enumeration value.
Definition: ContrastMethod.h:183
ContrastMethod(enum_value value)
Construct a ContrastMethod enumeration by an enumeration value.
Definition: ContrastMethod.cpp:141
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: ContrastMethod.cpp:74
Fluorescence.
Definition: ContrastMethod.h:91
Boost.Log compatibility.
const std::string * name
Enumeration name.
Definition: ContrastMethod.h:185
Xerces-C modern C++ wrapper.
Definition: Base.h:53