ome-xml 5.2.3

Marker.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_MARKER_H
47 #define OME_XML_MODEL_ENUMS_MARKER_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 Marker enumeration.
58 #define OME_XML_MODEL_ENUMS_MARKER_VALUES (ARROW)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class Marker
73 {
74 public:
76 enum enum_value
77 {
79 ARROW
80 };
81
87 Marker (enum_value value);
88
103 Marker (const std::string& name, bool strict = true);
104
110 Marker (const Marker& original);
111
116 inline Marker&
117 operator= (const Marker& rhs)
118 {
119 this->value = rhs.value;
120 this->name = rhs.name;
121 return *this;
122 }
123
129 inline
130 operator enum_value () const
131 {
132 return this->value;
133 }
134
140 inline
141 operator const std::string& () const
142 {
143 return *this->name;
144 }
145
147 typedef std::map<std::string, Marker::enum_value> string_map_type;
149 typedef std::map<Marker::enum_value, std::string> value_map_type;
150
156 static const string_map_type&
157 strings();
158
164 static const value_map_type&
165 values();
166
167 private:
173 static const string_map_type&
174 lowercase_strings();
175
177 enum_value value;
179 const std::string *name;
180 };
181
189 inline bool
190 operator== (const Marker& lhs,
191 const Marker& rhs)
192 {
193 return static_cast<Marker::enum_value>(lhs) == static_cast<Marker::enum_value>(rhs);
194 }
195
203 inline bool
204 operator== (const Marker& lhs,
205 const Marker::enum_value& rhs)
206 {
207 return static_cast<Marker::enum_value>(lhs) == rhs;
208 }
209
217 inline bool
218 operator== (const Marker::enum_value& lhs,
219 const Marker& rhs)
220 {
221 return lhs == static_cast<Marker::enum_value>(rhs);
222 }
223
231 inline bool
232 operator== (const Marker& lhs,
233 const std::string& rhs)
234 {
235 return static_cast<const std::string&>(lhs) == rhs;
236 }
237
245 inline bool
246 operator== (const std::string& lhs,
247 const Marker& rhs)
248 {
249 return lhs == static_cast<const std::string&>(rhs);
250 }
251
259 inline bool
260 operator!= (const Marker& lhs,
261 const Marker& rhs)
262 {
263 return static_cast<Marker::enum_value>(lhs) != static_cast<Marker::enum_value>(rhs);
264 }
265
273 inline bool
274 operator!= (const Marker& lhs,
275 const Marker::enum_value& rhs)
276 {
277 return static_cast<Marker::enum_value>(lhs) != rhs;
278 }
279
287 inline bool
288 operator!= (const Marker::enum_value& lhs,
289 const Marker& rhs)
290 {
291 return lhs != static_cast<Marker::enum_value>(rhs);
292 }
293
301 inline bool
302 operator!= (const Marker& lhs,
303 const std::string& rhs)
304 {
305 return static_cast<const std::string&>(lhs) != rhs;
306 }
307
315 inline bool
316 operator!= (const std::string& lhs,
317 const Marker& rhs)
318 {
319 return lhs != static_cast<const std::string&>(rhs);
320 }
321
329 template<class charT, class traits>
330 inline std::basic_ostream<charT,traits>&
331 operator<< (std::basic_ostream<charT,traits>& os,
332 const Marker& enumeration)
333 {
334 return os << static_cast<const std::string&>(enumeration);
335 }
336
344 template<class charT, class traits>
345 inline std::basic_istream<charT,traits>&
346 operator>> (std::basic_istream<charT,traits>& is,
347 Marker& enumeration)
348 {
349 std::string value;
350 is >> value;
351 if (is)
352 {
353 try
354 {
355 enumeration = Marker(value, false);
356 }
357 catch (const EnumerationException&)
358 {
359 is.setstate(std::ios::failbit);
360 }
361 }
362
363 return is;
364 }
365
366 }
367 }
368 }
369 }
370
371 #endif // OME_XML_MODEL_ENUMS_MARKER_H
372
373 /*
374 * Local Variables:
375 * mode:C++
376 * End:
377 */
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::Marker::ARROW
Arrow.
Definition: Marker.h:79
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::Marker::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Marker.cpp:152
ome::xml::model::enums::Marker::enum_value
enum_value
Enumeration values.
Definition: Marker.h:76
ome::xml::model::enums::Marker
Marker enumeration.
Definition: Marker.h:72
ome::xml::model::enums::Marker::string_map_type
std::map< std::string, Marker::enum_value > string_map_type
String map type.
Definition: Marker.h:147
ome::xml::model::enums::Marker::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Marker.cpp:138
ome::xml::model::enums::Marker::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: Marker.cpp:166
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::Marker::value_map_type
std::map< Marker::enum_value, std::string > value_map_type
Value map type.
Definition: Marker.h:149
ome::xml::model::enums::Marker::Marker
Marker(enum_value value)
Construct a Marker enumeration by an enumeration value.
Definition: Marker.cpp:75
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::Marker::value
enum_value value
Enumeration value.
Definition: Marker.h:177
ome::xml::model::enums::Marker::name
const std::string * name
Enumeration name.
Definition: Marker.h:179
ome::xml::model::enums::Marker::operator=
Marker & operator=(const Marker &rhs)
Assignment operator.
Definition: Marker.h:117
log.h