ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

ExperimentType.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_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 // All values in the ExperimentType enumeration.
58 #define OME_XML_MODEL_ENUMS_EXPERIMENTTYPE_VALUES (FP)(FRET)(TIMELAPSE)(FOURDPLUS)(SCREEN)(IMMUNOCYTOCHEMISTRY)(IMMUNOFLUORESCENCE)(FISH)(ELECTROPHYSIOLOGY)(IONIMAGING)(COLOCALIZATION)(PGIDOCUMENTATION)(FLUORESCENCELIFETIME)(SPECTRALIMAGING)(PHOTOBLEACHING)(SPIM)(OTHER)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class ExperimentType
73 {
74 public:
76 enum enum_value
77 {
79 FP,
81 FRET,
83 TIMELAPSE,
85 FOURDPLUS,
87 SCREEN,
89 IMMUNOCYTOCHEMISTRY,
91 IMMUNOFLUORESCENCE,
93 FISH,
95 ELECTROPHYSIOLOGY,
97 IONIMAGING,
99 COLOCALIZATION,
101 PGIDOCUMENTATION,
103 FLUORESCENCELIFETIME,
105 SPECTRALIMAGING,
107 PHOTOBLEACHING,
109 SPIM,
111 OTHER
112 };
113
119 ExperimentType (enum_value value);
120
135 ExperimentType (const std::string& name, bool strict = true);
136
142 ExperimentType (const ExperimentType& original);
143
148 inline ExperimentType&
149 operator= (const ExperimentType& rhs)
150 {
151 this->value = rhs.value;
152 this->name = rhs.name;
153 return *this;
154 }
155
161 inline
162 operator enum_value () const
163 {
164 return this->value;
165 }
166
172 inline
173 operator const std::string& () const
174 {
175 return *this->name;
176 }
177
179 typedef std::map<std::string, ExperimentType::enum_value> string_map_type;
181 typedef std::map<ExperimentType::enum_value, std::string> value_map_type;
182
188 static const string_map_type&
189 strings();
190
196 static const value_map_type&
197 values();
198
199 private:
205 static const string_map_type&
206 lowercase_strings();
207
209 enum_value value;
211 const std::string *name;
212 };
213
221 inline bool
222 operator== (const ExperimentType& lhs,
223 const ExperimentType& rhs)
224 {
225 return static_cast<ExperimentType::enum_value>(lhs) == static_cast<ExperimentType::enum_value>(rhs);
226 }
227
235 inline bool
236 operator== (const ExperimentType& lhs,
237 const ExperimentType::enum_value& rhs)
238 {
239 return static_cast<ExperimentType::enum_value>(lhs) == rhs;
240 }
241
249 inline bool
250 operator== (const ExperimentType::enum_value& lhs,
251 const ExperimentType& rhs)
252 {
253 return lhs == static_cast<ExperimentType::enum_value>(rhs);
254 }
255
263 inline bool
264 operator== (const ExperimentType& lhs,
265 const std::string& rhs)
266 {
267 return static_cast<const std::string&>(lhs) == rhs;
268 }
269
277 inline bool
278 operator== (const std::string& lhs,
279 const ExperimentType& rhs)
280 {
281 return lhs == static_cast<const std::string&>(rhs);
282 }
283
291 inline bool
292 operator!= (const ExperimentType& lhs,
293 const ExperimentType& rhs)
294 {
295 return static_cast<ExperimentType::enum_value>(lhs) != static_cast<ExperimentType::enum_value>(rhs);
296 }
297
305 inline bool
306 operator!= (const ExperimentType& lhs,
307 const ExperimentType::enum_value& rhs)
308 {
309 return static_cast<ExperimentType::enum_value>(lhs) != rhs;
310 }
311
319 inline bool
320 operator!= (const ExperimentType::enum_value& lhs,
321 const ExperimentType& rhs)
322 {
323 return lhs != static_cast<ExperimentType::enum_value>(rhs);
324 }
325
333 inline bool
334 operator!= (const ExperimentType& lhs,
335 const std::string& rhs)
336 {
337 return static_cast<const std::string&>(lhs) != rhs;
338 }
339
347 inline bool
348 operator!= (const std::string& lhs,
349 const ExperimentType& rhs)
350 {
351 return lhs != static_cast<const std::string&>(rhs);
352 }
353
361 template<class charT, class traits>
362 inline std::basic_ostream<charT,traits>&
363 operator<< (std::basic_ostream<charT,traits>& os,
364 const ExperimentType& enumeration)
365 {
366 return os << static_cast<const std::string&>(enumeration);
367 }
368
376 template<class charT, class traits>
377 inline std::basic_istream<charT,traits>&
378 operator>> (std::basic_istream<charT,traits>& is,
379 ExperimentType& enumeration)
380 {
381 std::string value;
382 is >> value;
383 if (is)
384 {
385 try
386 {
387 enumeration = ExperimentType(value, false);
388 }
389 catch (const EnumerationException&)
390 {
391 is.setstate(std::ios::failbit);
392 }
393 }
394
395 return is;
396 }
397
398 }
399 }
400 }
401 }
402
403 #endif // OME_XML_MODEL_ENUMS_EXPERIMENTTYPE_H
404
405 /*
406 * Local Variables:
407 * mode:C++
408 * End:
409 */
ome::xml::model::enums::operator>>
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:384
ome::xml::model::enums::ExperimentType::IMMUNOCYTOCHEMISTRY
Immunocytochemistry.
Definition: ExperimentType.h:89
ome::xml::model::enums::operator!=
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:298
ome::xml::model::enums::ExperimentType
ExperimentType enumeration.
Definition: ExperimentType.h:72
ome::xml::model::enums::ExperimentType::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: ExperimentType.cpp:183
ome::xml::model::enums::ExperimentType::value_map_type
std::map< ExperimentType::enum_value, std::string > value_map_type
Value map type.
Definition: ExperimentType.h:181
ome::xml::model::enums::ExperimentType::COLOCALIZATION
Colocalization.
Definition: ExperimentType.h:99
ome::xml::model::enums::ExperimentType::SCREEN
Screen.
Definition: ExperimentType.h:87
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::ExperimentType::OTHER
Other.
Definition: ExperimentType.h:111
ome::xml::model::enums::ExperimentType::FLUORESCENCELIFETIME
FluorescenceLifetime.
Definition: ExperimentType.h:103
ome::xml::model::enums::ExperimentType::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: ExperimentType.cpp:213
ome::xml::model::enums::ExperimentType::FP
FP.
Definition: ExperimentType.h:79
ome::xml::model::enums::ExperimentType::FISH
FISH.
Definition: ExperimentType.h:93
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::ExperimentType::enum_value
enum_value
Enumeration values.
Definition: ExperimentType.h:76
ome::xml::model::enums::operator==
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:228
ome::xml::model::enums::ExperimentType::string_map_type
std::map< std::string, ExperimentType::enum_value > string_map_type
String map type.
Definition: ExperimentType.h:179
ome::xml::model::enums::ExperimentType::operator=
ExperimentType & operator=(const ExperimentType &rhs)
Assignment operator.
Definition: ExperimentType.h:149
ome::xml::model::enums::ExperimentType::ELECTROPHYSIOLOGY
Electrophysiology.
Definition: ExperimentType.h:95
ome::xml::model::enums::ExperimentType::TIMELAPSE
TimeLapse.
Definition: ExperimentType.h:83
ome::xml::model::enums::ExperimentType::PHOTOBLEACHING
Photobleaching.
Definition: ExperimentType.h:107
ome::xml::model::enums::ExperimentType::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: ExperimentType.cpp:153
ome::xml::model::enums::ExperimentType::PGIDOCUMENTATION
PGIDocumentation.
Definition: ExperimentType.h:101
ome::xml::model::enums::ExperimentType::FRET
FRET.
Definition: ExperimentType.h:81
ome::xml::model::enums::ExperimentType::SPECTRALIMAGING
SpectralImaging.
Definition: ExperimentType.h:105
ome::xml::model::enums::ExperimentType::value
enum_value value
Enumeration value.
Definition: ExperimentType.h:209
ome::xml::model::enums::ExperimentType::FOURDPLUS
FourDPlus.
Definition: ExperimentType.h:85
ome::xml::model::enums::ExperimentType::IMMUNOFLUORESCENCE
Immunofluorescence.
Definition: ExperimentType.h:91
ome::xml::model::enums::ExperimentType::IONIMAGING
IonImaging.
Definition: ExperimentType.h:97
ome::xml::model::enums::ExperimentType::ExperimentType
ExperimentType(enum_value value)
Construct a ExperimentType enumeration by an enumeration value.
Definition: ExperimentType.cpp:75
log.h
ome::xml::model::enums::ExperimentType::name
const std::string * name
Enumeration name.
Definition: ExperimentType.h:211
ome::xml::model::enums::ExperimentType::SPIM
SPIM.
Definition: ExperimentType.h:109