ome-xml 5.2.3

MicrobeamManipulationType.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_MICROBEAMMANIPULATIONTYPE_H
47 #define OME_XML_MODEL_ENUMS_MICROBEAMMANIPULATIONTYPE_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 MicrobeamManipulationType enumeration.
58 #define OME_XML_MODEL_ENUMS_MICROBEAMMANIPULATIONTYPE_VALUES (FRAP)(FLIP)(INVERSEFRAP)(PHOTOABLATION)(PHOTOACTIVATION)(UNCAGING)(OPTICALTRAPPING)(OTHER)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class MicrobeamManipulationType
73 {
74 public:
76 enum enum_value
77 {
79 FRAP,
81 FLIP,
83 INVERSEFRAP,
85 PHOTOABLATION,
87 PHOTOACTIVATION,
89 UNCAGING,
91 OPTICALTRAPPING,
93 OTHER
94 };
95
101 MicrobeamManipulationType (enum_value value);
102
117 MicrobeamManipulationType (const std::string& name, bool strict = true);
118
124 MicrobeamManipulationType (const MicrobeamManipulationType& original);
125
130 inline MicrobeamManipulationType&
131 operator= (const MicrobeamManipulationType& rhs)
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, MicrobeamManipulationType::enum_value> string_map_type;
163 typedef std::map<MicrobeamManipulationType::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:
187 static const string_map_type&
188 lowercase_strings();
189
191 enum_value value;
193 const std::string *name;
194 };
195
203 inline bool
204 operator== (const MicrobeamManipulationType& lhs,
205 const MicrobeamManipulationType& rhs)
206 {
207 return static_cast<MicrobeamManipulationType::enum_value>(lhs) == static_cast<MicrobeamManipulationType::enum_value>(rhs);
208 }
209
217 inline bool
218 operator== (const MicrobeamManipulationType& lhs,
219 const MicrobeamManipulationType::enum_value& rhs)
220 {
221 return static_cast<MicrobeamManipulationType::enum_value>(lhs) == rhs;
222 }
223
231 inline bool
232 operator== (const MicrobeamManipulationType::enum_value& lhs,
233 const MicrobeamManipulationType& rhs)
234 {
235 return lhs == static_cast<MicrobeamManipulationType::enum_value>(rhs);
236 }
237
245 inline bool
246 operator== (const MicrobeamManipulationType& lhs,
247 const std::string& rhs)
248 {
249 return static_cast<const std::string&>(lhs) == rhs;
250 }
251
259 inline bool
260 operator== (const std::string& lhs,
261 const MicrobeamManipulationType& rhs)
262 {
263 return lhs == static_cast<const std::string&>(rhs);
264 }
265
273 inline bool
274 operator!= (const MicrobeamManipulationType& lhs,
275 const MicrobeamManipulationType& rhs)
276 {
277 return static_cast<MicrobeamManipulationType::enum_value>(lhs) != static_cast<MicrobeamManipulationType::enum_value>(rhs);
278 }
279
287 inline bool
288 operator!= (const MicrobeamManipulationType& lhs,
289 const MicrobeamManipulationType::enum_value& rhs)
290 {
291 return static_cast<MicrobeamManipulationType::enum_value>(lhs) != rhs;
292 }
293
301 inline bool
302 operator!= (const MicrobeamManipulationType::enum_value& lhs,
303 const MicrobeamManipulationType& rhs)
304 {
305 return lhs != static_cast<MicrobeamManipulationType::enum_value>(rhs);
306 }
307
315 inline bool
316 operator!= (const MicrobeamManipulationType& lhs,
317 const std::string& rhs)
318 {
319 return static_cast<const std::string&>(lhs) != rhs;
320 }
321
329 inline bool
330 operator!= (const std::string& lhs,
331 const MicrobeamManipulationType& rhs)
332 {
333 return lhs != static_cast<const std::string&>(rhs);
334 }
335
343 template<class charT, class traits>
344 inline std::basic_ostream<charT,traits>&
345 operator<< (std::basic_ostream<charT,traits>& os,
346 const MicrobeamManipulationType& enumeration)
347 {
348 return os << static_cast<const std::string&>(enumeration);
349 }
350
358 template<class charT, class traits>
359 inline std::basic_istream<charT,traits>&
360 operator>> (std::basic_istream<charT,traits>& is,
361 MicrobeamManipulationType& enumeration)
362 {
363 std::string value;
364 is >> value;
365 if (is)
366 {
367 try
368 {
369 enumeration = MicrobeamManipulationType(value, false);
370 }
371 catch (const EnumerationException&)
372 {
373 is.setstate(std::ios::failbit);
374 }
375 }
376
377 return is;
378 }
379
380 }
381 }
382 }
383 }
384
385 #endif // OME_XML_MODEL_ENUMS_MICROBEAMMANIPULATIONTYPE_H
386
387 /*
388 * Local Variables:
389 * mode:C++
390 * End:
391 */
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::MicrobeamManipulationType::FLIP
FLIP.
Definition: MicrobeamManipulationType.h:81
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::MicrobeamManipulationType::value_map_type
std::map< MicrobeamManipulationType::enum_value, std::string > value_map_type
Value map type.
Definition: MicrobeamManipulationType.h:163
ome::xml::model::enums::MicrobeamManipulationType::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: MicrobeamManipulationType.cpp:153
ome::xml::model::enums::MicrobeamManipulationType::INVERSEFRAP
InverseFRAP.
Definition: MicrobeamManipulationType.h:83
ome::xml::model::enums::MicrobeamManipulationType::enum_value
enum_value
Enumeration values.
Definition: MicrobeamManipulationType.h:76
ome::xml::model::enums::MicrobeamManipulationType::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: MicrobeamManipulationType.cpp:174
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::MicrobeamManipulationType::operator=
MicrobeamManipulationType & operator=(const MicrobeamManipulationType &rhs)
Assignment operator.
Definition: MicrobeamManipulationType.h:131
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::MicrobeamManipulationType
MicrobeamManipulationType enumeration.
Definition: MicrobeamManipulationType.h:72
ome::xml::model::enums::MicrobeamManipulationType::string_map_type
std::map< std::string, MicrobeamManipulationType::enum_value > string_map_type
String map type.
Definition: MicrobeamManipulationType.h:161
ome::xml::model::enums::MicrobeamManipulationType::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: MicrobeamManipulationType.cpp:195
ome::xml::model::enums::MicrobeamManipulationType::value
enum_value value
Enumeration value.
Definition: MicrobeamManipulationType.h:191
ome::xml::model::enums::MicrobeamManipulationType::OTHER
Other.
Definition: MicrobeamManipulationType.h:93
ome::xml::model::enums::MicrobeamManipulationType::PHOTOABLATION
Photoablation.
Definition: MicrobeamManipulationType.h:85
ome::xml::model::enums::MicrobeamManipulationType::UNCAGING
Uncaging.
Definition: MicrobeamManipulationType.h:89
ome::xml::model::enums::MicrobeamManipulationType::PHOTOACTIVATION
Photoactivation.
Definition: MicrobeamManipulationType.h:87
ome::xml::model::enums::MicrobeamManipulationType::name
const std::string * name
Enumeration name.
Definition: MicrobeamManipulationType.h:193
log.h
ome::xml::model::enums::MicrobeamManipulationType::MicrobeamManipulationType
MicrobeamManipulationType(enum_value value)
Construct a MicrobeamManipulationType enumeration by an enumeration value.
Definition: MicrobeamManipulationType.cpp:75
ome::xml::model::enums::MicrobeamManipulationType::OPTICALTRAPPING
OpticalTrapping.
Definition: MicrobeamManipulationType.h:91
ome::xml::model::enums::MicrobeamManipulationType::FRAP
FRAP.
Definition: MicrobeamManipulationType.h:79