bioformats  5.1.8
DetectorType.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_DETECTORTYPE_H
47 #define OME_XML_MODEL_ENUMS_DETECTORTYPE_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 namespace ome
58 {
59  namespace xml
60  {
61  namespace model
62  {
63  namespace enums
64  {
65 
70  {
71  public:
74  {
76  CCD,
82  PMT,
96  APD,
103  };
104 
111 
126  DetectorType (const std::string& name, bool strict = true);
127 
133  DetectorType (const DetectorType& original);
134 
139  inline DetectorType&
141  {
142  this->value = rhs.value;
143  this->name = rhs.name;
144  return *this;
145  }
146 
152  inline
153  operator enum_value () const
154  {
155  return this->value;
156  }
157 
163  inline
164  operator const std::string& () const
165  {
166  return *this->name;
167  }
168 
170  typedef std::map<std::string, DetectorType::enum_value> string_map_type;
172  typedef std::map<DetectorType::enum_value, std::string> value_map_type;
173 
179  static const string_map_type&
180  strings();
181 
187  static const value_map_type&
188  values();
189 
190  private:
196  static const string_map_type&
198 
202  const std::string *name;
203  };
204 
212  inline bool
214  const DetectorType& rhs)
215  {
216  return static_cast<DetectorType::enum_value>(lhs) == static_cast<DetectorType::enum_value>(rhs);
217  }
218 
226  inline bool
228  const DetectorType::enum_value& rhs)
229  {
230  return static_cast<DetectorType::enum_value>(lhs) == rhs;
231  }
232 
240  inline bool
242  const DetectorType& rhs)
243  {
244  return lhs == static_cast<DetectorType::enum_value>(rhs);
245  }
246 
254  inline bool
256  const std::string& rhs)
257  {
258  return static_cast<const std::string&>(lhs) == rhs;
259  }
260 
268  inline bool
269  operator== (const std::string& lhs,
270  const DetectorType& rhs)
271  {
272  return lhs == static_cast<const std::string&>(rhs);
273  }
274 
282  inline bool
284  const DetectorType& rhs)
285  {
286  return static_cast<DetectorType::enum_value>(lhs) != static_cast<DetectorType::enum_value>(rhs);
287  }
288 
296  inline bool
298  const DetectorType::enum_value& rhs)
299  {
300  return static_cast<DetectorType::enum_value>(lhs) != rhs;
301  }
302 
310  inline bool
312  const DetectorType& rhs)
313  {
314  return lhs != static_cast<DetectorType::enum_value>(rhs);
315  }
316 
324  inline bool
326  const std::string& rhs)
327  {
328  return static_cast<const std::string&>(lhs) != rhs;
329  }
330 
338  inline bool
339  operator!= (const std::string& lhs,
340  const DetectorType& rhs)
341  {
342  return lhs != static_cast<const std::string&>(rhs);
343  }
344 
352  template<class charT, class traits>
353  inline std::basic_ostream<charT,traits>&
354  operator<< (std::basic_ostream<charT,traits>& os,
355  const DetectorType& enumeration)
356  {
357  return os << static_cast<const std::string&>(enumeration);
358  }
359 
367  template<class charT, class traits>
368  inline std::basic_istream<charT,traits>&
369  operator>> (std::basic_istream<charT,traits>& is,
370  DetectorType& enumeration)
371  {
372  std::string value;
373  is >> value;
374  if (is)
375  {
376  try
377  {
378  enumeration = DetectorType(value, false);
379  }
380  catch (const EnumerationException&)
381  {
382  is.setstate(std::ios::failbit);
383  }
384  }
385 
386  return is;
387  }
388 
389  }
390  }
391  }
392 }
393 
394 #endif // OME_XML_MODEL_ENUMS_DETECTORTYPE_H
395 
396 /*
397  * Local Variables:
398  * mode:C++
399  * End:
400  */
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
const std::string * name
Enumeration name.
Definition: DetectorType.h:202
IntensifiedCCD.
Definition: DetectorType.h:78
enum_value
Enumeration values.
Definition: DetectorType.h:73
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
enum_value value
Enumeration value.
Definition: DetectorType.h:200
Photodiode.
Definition: DetectorType.h:84
APD.
Definition: DetectorType.h:96
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: DetectorType.cpp:153
EBCCD.
Definition: DetectorType.h:100
EMCCD.
Definition: DetectorType.h:94
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
PMT.
Definition: DetectorType.h:82
DetectorType(enum_value value)
Construct a DetectorType enumeration by an enumeration value.
Definition: DetectorType.cpp:75
DetectorType enumeration.
Definition: DetectorType.h:69
CorrelationSpectroscopy.
Definition: DetectorType.h:90
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: DetectorType.cpp:207
std::map< DetectorType::enum_value, std::string > value_map_type
Value map type.
Definition: DetectorType.h:172
Spectroscopy.
Definition: DetectorType.h:86
DetectorType & operator=(const DetectorType &rhs)
Assignment operator.
Definition: DetectorType.h:140
std::map< std::string, DetectorType::enum_value > string_map_type
String map type.
Definition: DetectorType.h:170
CCD.
Definition: DetectorType.h:76
FTIR.
Definition: DetectorType.h:92
Other.
Definition: DetectorType.h:102
LifetimeImaging.
Definition: DetectorType.h:88
AnalogVideo.
Definition: DetectorType.h:80
Boost.Log compatibility.
CMOS.
Definition: DetectorType.h:98
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: DetectorType.cpp:180
Xerces-C modern C++ wrapper.
Definition: Base.h:53