ome-xml 5.2.3

MicroscopeType.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_MICROSCOPETYPE_H
47 #define OME_XML_MODEL_ENUMS_MICROSCOPETYPE_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 MicroscopeType enumeration.
58 #define OME_XML_MODEL_ENUMS_MICROSCOPETYPE_VALUES (UPRIGHT)(INVERTED)(DISSECTION)(ELECTROPHYSIOLOGY)(OTHER)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class MicroscopeType
73 {
74 public:
76 enum enum_value
77 {
79 UPRIGHT,
81 INVERTED,
83 DISSECTION,
85 ELECTROPHYSIOLOGY,
87 OTHER
88 };
89
95 MicroscopeType (enum_value value);
96
111 MicroscopeType (const std::string& name, bool strict = true);
112
118 MicroscopeType (const MicroscopeType& original);
119
124 inline MicroscopeType&
125 operator= (const MicroscopeType& rhs)
126 {
127 this->value = rhs.value;
128 this->name = rhs.name;
129 return *this;
130 }
131
137 inline
138 operator enum_value () const
139 {
140 return this->value;
141 }
142
148 inline
149 operator const std::string& () const
150 {
151 return *this->name;
152 }
153
155 typedef std::map<std::string, MicroscopeType::enum_value> string_map_type;
157 typedef std::map<MicroscopeType::enum_value, std::string> value_map_type;
158
164 static const string_map_type&
165 strings();
166
172 static const value_map_type&
173 values();
174
175 private:
181 static const string_map_type&
182 lowercase_strings();
183
185 enum_value value;
187 const std::string *name;
188 };
189
197 inline bool
198 operator== (const MicroscopeType& lhs,
199 const MicroscopeType& rhs)
200 {
201 return static_cast<MicroscopeType::enum_value>(lhs) == static_cast<MicroscopeType::enum_value>(rhs);
202 }
203
211 inline bool
212 operator== (const MicroscopeType& lhs,
213 const MicroscopeType::enum_value& rhs)
214 {
215 return static_cast<MicroscopeType::enum_value>(lhs) == rhs;
216 }
217
225 inline bool
226 operator== (const MicroscopeType::enum_value& lhs,
227 const MicroscopeType& rhs)
228 {
229 return lhs == static_cast<MicroscopeType::enum_value>(rhs);
230 }
231
239 inline bool
240 operator== (const MicroscopeType& lhs,
241 const std::string& rhs)
242 {
243 return static_cast<const std::string&>(lhs) == rhs;
244 }
245
253 inline bool
254 operator== (const std::string& lhs,
255 const MicroscopeType& rhs)
256 {
257 return lhs == static_cast<const std::string&>(rhs);
258 }
259
267 inline bool
268 operator!= (const MicroscopeType& lhs,
269 const MicroscopeType& rhs)
270 {
271 return static_cast<MicroscopeType::enum_value>(lhs) != static_cast<MicroscopeType::enum_value>(rhs);
272 }
273
281 inline bool
282 operator!= (const MicroscopeType& lhs,
283 const MicroscopeType::enum_value& rhs)
284 {
285 return static_cast<MicroscopeType::enum_value>(lhs) != rhs;
286 }
287
295 inline bool
296 operator!= (const MicroscopeType::enum_value& lhs,
297 const MicroscopeType& rhs)
298 {
299 return lhs != static_cast<MicroscopeType::enum_value>(rhs);
300 }
301
309 inline bool
310 operator!= (const MicroscopeType& lhs,
311 const std::string& rhs)
312 {
313 return static_cast<const std::string&>(lhs) != rhs;
314 }
315
323 inline bool
324 operator!= (const std::string& lhs,
325 const MicroscopeType& rhs)
326 {
327 return lhs != static_cast<const std::string&>(rhs);
328 }
329
337 template<class charT, class traits>
338 inline std::basic_ostream<charT,traits>&
339 operator<< (std::basic_ostream<charT,traits>& os,
340 const MicroscopeType& enumeration)
341 {
342 return os << static_cast<const std::string&>(enumeration);
343 }
344
352 template<class charT, class traits>
353 inline std::basic_istream<charT,traits>&
354 operator>> (std::basic_istream<charT,traits>& is,
355 MicroscopeType& enumeration)
356 {
357 std::string value;
358 is >> value;
359 if (is)
360 {
361 try
362 {
363 enumeration = MicroscopeType(value, false);
364 }
365 catch (const EnumerationException&)
366 {
367 is.setstate(std::ios::failbit);
368 }
369 }
370
371 return is;
372 }
373
374 }
375 }
376 }
377 }
378
379 #endif // OME_XML_MODEL_ENUMS_MICROSCOPETYPE_H
380
381 /*
382 * Local Variables:
383 * mode:C++
384 * End:
385 */
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:390
ome::xml::model::enums::operator!=
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:304
ome::xml::model::enums::MicroscopeType::ELECTROPHYSIOLOGY
Electrophysiology.
Definition: MicroscopeType.h:85
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::MicroscopeType::INVERTED
Inverted.
Definition: MicroscopeType.h:81
ome::xml::model::enums::MicroscopeType::name
const std::string * name
Enumeration name.
Definition: MicroscopeType.h:187
ome::xml::model::enums::MicroscopeType::OTHER
Other.
Definition: MicroscopeType.h:87
ome::xml::model::enums::MicroscopeType::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: MicroscopeType.cpp:153
ome::xml::model::enums::MicroscopeType::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: MicroscopeType.cpp:189
ome::xml::model::enums::MicroscopeType::UPRIGHT
Upright.
Definition: MicroscopeType.h:79
ome::xml::model::enums::MicroscopeType::DISSECTION
Dissection.
Definition: MicroscopeType.h:83
ome::xml::model::enums::MicroscopeType::enum_value
enum_value
Enumeration values.
Definition: MicroscopeType.h:76
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::MicroscopeType::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: MicroscopeType.cpp:171
ome::xml::model::enums::operator==
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:234
ome::xml::model::enums::MicroscopeType::value
enum_value value
Enumeration value.
Definition: MicroscopeType.h:185
ome::xml::model::enums::MicroscopeType::string_map_type
std::map< std::string, MicroscopeType::enum_value > string_map_type
String map type.
Definition: MicroscopeType.h:155
ome::xml::model::enums::MicroscopeType::operator=
MicroscopeType & operator=(const MicroscopeType &rhs)
Assignment operator.
Definition: MicroscopeType.h:125
ome::xml::model::enums::MicroscopeType::MicroscopeType
MicroscopeType(enum_value value)
Construct a MicroscopeType enumeration by an enumeration value.
Definition: MicroscopeType.cpp:75
log.h
ome::xml::model::enums::MicroscopeType
MicroscopeType enumeration.
Definition: MicroscopeType.h:72
ome::xml::model::enums::MicroscopeType::value_map_type
std::map< MicroscopeType::enum_value, std::string > value_map_type
Value map type.
Definition: MicroscopeType.h:157