bioformats  5.1.6
ExperimentType.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_EXPERIMENTTYPE_H
47 #define OME_XML_MODEL_ENUMS_EXPERIMENTTYPE_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  FP,
109  };
110 
117 
132  ExperimentType (const std::string& name, bool strict = true);
133 
139  ExperimentType (const ExperimentType& original);
140 
145  inline ExperimentType&
147  {
148  this->value = rhs.value;
149  this->name = rhs.name;
150  return *this;
151  }
152 
158  inline
159  operator enum_value () const
160  {
161  return this->value;
162  }
163 
169  inline
170  operator const std::string& () const
171  {
172  return *this->name;
173  }
174 
176  typedef std::map<std::string, ExperimentType::enum_value> string_map_type;
178  typedef std::map<ExperimentType::enum_value, std::string> value_map_type;
179 
185  static const string_map_type&
186  strings();
187 
193  static const value_map_type&
194  values();
195 
196  private:
202  static const string_map_type&
204 
208  const std::string *name;
209  };
210 
218  inline bool
220  const ExperimentType& rhs)
221  {
222  return static_cast<ExperimentType::enum_value>(lhs) == static_cast<ExperimentType::enum_value>(rhs);
223  }
224 
232  inline bool
234  const ExperimentType::enum_value& rhs)
235  {
236  return static_cast<ExperimentType::enum_value>(lhs) == rhs;
237  }
238 
246  inline bool
248  const ExperimentType& rhs)
249  {
250  return lhs == static_cast<ExperimentType::enum_value>(rhs);
251  }
252 
260  inline bool
262  const std::string& rhs)
263  {
264  return static_cast<const std::string&>(lhs) == rhs;
265  }
266 
274  inline bool
275  operator== (const std::string& lhs,
276  const ExperimentType& rhs)
277  {
278  return lhs == static_cast<const std::string&>(rhs);
279  }
280 
288  inline bool
290  const ExperimentType& rhs)
291  {
292  return static_cast<ExperimentType::enum_value>(lhs) != static_cast<ExperimentType::enum_value>(rhs);
293  }
294 
302  inline bool
304  const ExperimentType::enum_value& rhs)
305  {
306  return static_cast<ExperimentType::enum_value>(lhs) != rhs;
307  }
308 
316  inline bool
318  const ExperimentType& rhs)
319  {
320  return lhs != static_cast<ExperimentType::enum_value>(rhs);
321  }
322 
330  inline bool
332  const std::string& rhs)
333  {
334  return static_cast<const std::string&>(lhs) != rhs;
335  }
336 
344  inline bool
345  operator!= (const std::string& lhs,
346  const ExperimentType& rhs)
347  {
348  return lhs != static_cast<const std::string&>(rhs);
349  }
350 
358  template<class charT, class traits>
359  inline std::basic_ostream<charT,traits>&
360  operator<< (std::basic_ostream<charT,traits>& os,
361  const ExperimentType& enumeration)
362  {
363  return os << static_cast<const std::string&>(enumeration);
364  }
365 
373  template<class charT, class traits>
374  inline std::basic_istream<charT,traits>&
375  operator>> (std::basic_istream<charT,traits>& is,
376  ExperimentType& enumeration)
377  {
378  std::string value;
379  is >> value;
380  if (is)
381  {
382  try
383  {
384  enumeration = ExperimentType(value, false);
385  }
386  catch (const EnumerationException&)
387  {
388  is.setstate(std::ios::failbit);
389  }
390  }
391 
392  return is;
393  }
394 
395  }
396  }
397  }
398 }
399 
400 #endif // OME_XML_MODEL_ENUMS_EXPERIMENTTYPE_H
401 
402 /*
403  * Local Variables:
404  * mode:C++
405  * End:
406  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:381
Immunocytochemistry.
Definition: ExperimentType.h:86
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:295
ExperimentType enumeration.
Definition: ExperimentType.h:69
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: ExperimentType.cpp:183
std::map< ExperimentType::enum_value, std::string > value_map_type
Value map type.
Definition: ExperimentType.h:178
Colocalization.
Definition: ExperimentType.h:96
Screen.
Definition: ExperimentType.h:84
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
Other.
Definition: ExperimentType.h:108
FluorescenceLifetime.
Definition: ExperimentType.h:100
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: ExperimentType.cpp:213
FP.
Definition: ExperimentType.h:76
FISH.
Definition: ExperimentType.h:90
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
enum_value
Enumeration values.
Definition: ExperimentType.h:73
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
std::map< std::string, ExperimentType::enum_value > string_map_type
String map type.
Definition: ExperimentType.h:176
ExperimentType & operator=(const ExperimentType &rhs)
Assignment operator.
Definition: ExperimentType.h:146
Electrophysiology.
Definition: ExperimentType.h:92
TimeLapse.
Definition: ExperimentType.h:80
Photobleaching.
Definition: ExperimentType.h:104
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: ExperimentType.cpp:153
PGIDocumentation.
Definition: ExperimentType.h:98
FRET.
Definition: ExperimentType.h:78
SpectralImaging.
Definition: ExperimentType.h:102
enum_value value
Enumeration value.
Definition: ExperimentType.h:206
FourDPlus.
Definition: ExperimentType.h:82
Immunofluorescence.
Definition: ExperimentType.h:88
IonImaging.
Definition: ExperimentType.h:94
ExperimentType(enum_value value)
Construct a ExperimentType enumeration by an enumeration value.
Definition: ExperimentType.cpp:75
Boost.Log compatibility.
const std::string * name
Enumeration name.
Definition: ExperimentType.h:208
Xerces-C modern C++ wrapper.
Definition: Base.h:53
SPIM.
Definition: ExperimentType.h:106