ome-xml 5.2.0

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

- File List

ArcType.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_ARCTYPE_H
47 #define OME_XML_MODEL_ENUMS_ARCTYPE_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 ArcType enumeration.
58 #define OME_XML_MODEL_ENUMS_ARCTYPE_VALUES (HG)(XE)(HGXE)(OTHER)
59
60 namespace ome
61 {
62 namespace xml
63 {
64 namespace model
65 {
66 namespace enums
67 {
68
72 class ArcType
73 {
74 public:
76 enum enum_value
77 {
79 HG,
81 XE,
83 HGXE,
85 OTHER
86 };
87
93 ArcType (enum_value value);
94
109 ArcType (const std::string& name, bool strict = true);
110
116 ArcType (const ArcType& original);
117
122 inline ArcType&
123 operator= (const ArcType& rhs)
124 {
125 this->value = rhs.value;
126 this->name = rhs.name;
127 return *this;
128 }
129
135 inline
136 operator enum_value () const
137 {
138 return this->value;
139 }
140
146 inline
147 operator const std::string& () const
148 {
149 return *this->name;
150 }
151
153 typedef std::map<std::string, ArcType::enum_value> string_map_type;
155 typedef std::map<ArcType::enum_value, std::string> value_map_type;
156
162 static const string_map_type&
163 strings();
164
170 static const value_map_type&
171 values();
172
173 private:
179 static const string_map_type&
180 lowercase_strings();
181
183 enum_value value;
185 const std::string *name;
186 };
187
195 inline bool
196 operator== (const ArcType& lhs,
197 const ArcType& rhs)
198 {
199 return static_cast<ArcType::enum_value>(lhs) == static_cast<ArcType::enum_value>(rhs);
200 }
201
209 inline bool
210 operator== (const ArcType& lhs,
211 const ArcType::enum_value& rhs)
212 {
213 return static_cast<ArcType::enum_value>(lhs) == rhs;
214 }
215
223 inline bool
224 operator== (const ArcType::enum_value& lhs,
225 const ArcType& rhs)
226 {
227 return lhs == static_cast<ArcType::enum_value>(rhs);
228 }
229
237 inline bool
238 operator== (const ArcType& lhs,
239 const std::string& rhs)
240 {
241 return static_cast<const std::string&>(lhs) == rhs;
242 }
243
251 inline bool
252 operator== (const std::string& lhs,
253 const ArcType& rhs)
254 {
255 return lhs == static_cast<const std::string&>(rhs);
256 }
257
265 inline bool
266 operator!= (const ArcType& lhs,
267 const ArcType& rhs)
268 {
269 return static_cast<ArcType::enum_value>(lhs) != static_cast<ArcType::enum_value>(rhs);
270 }
271
279 inline bool
280 operator!= (const ArcType& lhs,
281 const ArcType::enum_value& rhs)
282 {
283 return static_cast<ArcType::enum_value>(lhs) != rhs;
284 }
285
293 inline bool
294 operator!= (const ArcType::enum_value& lhs,
295 const ArcType& rhs)
296 {
297 return lhs != static_cast<ArcType::enum_value>(rhs);
298 }
299
307 inline bool
308 operator!= (const ArcType& lhs,
309 const std::string& rhs)
310 {
311 return static_cast<const std::string&>(lhs) != rhs;
312 }
313
321 inline bool
322 operator!= (const std::string& lhs,
323 const ArcType& rhs)
324 {
325 return lhs != static_cast<const std::string&>(rhs);
326 }
327
335 template<class charT, class traits>
336 inline std::basic_ostream<charT,traits>&
337 operator<< (std::basic_ostream<charT,traits>& os,
338 const ArcType& enumeration)
339 {
340 return os << static_cast<const std::string&>(enumeration);
341 }
342
350 template<class charT, class traits>
351 inline std::basic_istream<charT,traits>&
352 operator>> (std::basic_istream<charT,traits>& is,
353 ArcType& enumeration)
354 {
355 std::string value;
356 is >> value;
357 if (is)
358 {
359 try
360 {
361 enumeration = ArcType(value, false);
362 }
363 catch (const EnumerationException&)
364 {
365 is.setstate(std::ios::failbit);
366 }
367 }
368
369 return is;
370 }
371
372 }
373 }
374 }
375 }
376
377 #endif // OME_XML_MODEL_ENUMS_ARCTYPE_H
378
379 /*
380 * Local Variables:
381 * mode:C++
382 * End:
383 */
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::ArcType::HG
Hg.
Definition: ArcType.h:79
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::ArcType
ArcType enumeration.
Definition: ArcType.h:72
ome::xml::model::enums::ArcType::enum_value
enum_value
Enumeration values.
Definition: ArcType.h:76
ome::xml::model::enums::EnumerationException
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ome::xml::model::enums::ArcType::ArcType
ArcType(enum_value value)
Construct a ArcType enumeration by an enumeration value.
Definition: ArcType.cpp:75
ome::xml::model::enums::ArcType::OTHER
Other.
Definition: ArcType.h:85
ome::xml::model::enums::ArcType::values
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: ArcType.cpp:170
ome::xml::model::enums::ArcType::lowercase_strings
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: ArcType.cpp:187
ome::xml::model::enums::ArcType::HGXE
HgXe.
Definition: ArcType.h:83
ome::xml::model::enums::ArcType::string_map_type
std::map< std::string, ArcType::enum_value > string_map_type
String map type.
Definition: ArcType.h:153
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::enums::ArcType::XE
Xe.
Definition: ArcType.h:81
ome::xml::model::enums::ArcType::value_map_type
std::map< ArcType::enum_value, std::string > value_map_type
Value map type.
Definition: ArcType.h:155
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::ArcType::strings
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: ArcType.cpp:153
ome::xml::model::enums::ArcType::name
const std::string * name
Enumeration name.
Definition: ArcType.h:185
ome::xml::model::enums::ArcType::value
enum_value value
Enumeration value.
Definition: ArcType.h:183
ome::xml::model::enums::ArcType::operator=
ArcType & operator=(const ArcType &rhs)
Assignment operator.
Definition: ArcType.h:123
log.h