bioformats  5.1.6
ArcType.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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 namespace ome
58 {
59  namespace xml
60  {
61  namespace model
62  {
63  namespace enums
64  {
65 
69  class ArcType
70  {
71  public:
74  {
76  HG,
78  XE,
83  };
84 
91 
106  ArcType (const std::string& name, bool strict = true);
107 
113  ArcType (const ArcType& original);
114 
119  inline ArcType&
120  operator= (const ArcType& rhs)
121  {
122  this->value = rhs.value;
123  this->name = rhs.name;
124  return *this;
125  }
126 
132  inline
133  operator enum_value () const
134  {
135  return this->value;
136  }
137 
143  inline
144  operator const std::string& () const
145  {
146  return *this->name;
147  }
148 
150  typedef std::map<std::string, ArcType::enum_value> string_map_type;
152  typedef std::map<ArcType::enum_value, std::string> value_map_type;
153 
159  static const string_map_type&
160  strings();
161 
167  static const value_map_type&
168  values();
169 
170  private:
176  static const string_map_type&
178 
182  const std::string *name;
183  };
184 
192  inline bool
193  operator== (const ArcType& lhs,
194  const ArcType& rhs)
195  {
196  return static_cast<ArcType::enum_value>(lhs) == static_cast<ArcType::enum_value>(rhs);
197  }
198 
206  inline bool
207  operator== (const ArcType& lhs,
208  const ArcType::enum_value& rhs)
209  {
210  return static_cast<ArcType::enum_value>(lhs) == rhs;
211  }
212 
220  inline bool
222  const ArcType& rhs)
223  {
224  return lhs == static_cast<ArcType::enum_value>(rhs);
225  }
226 
234  inline bool
235  operator== (const ArcType& lhs,
236  const std::string& rhs)
237  {
238  return static_cast<const std::string&>(lhs) == rhs;
239  }
240 
248  inline bool
249  operator== (const std::string& lhs,
250  const ArcType& rhs)
251  {
252  return lhs == static_cast<const std::string&>(rhs);
253  }
254 
262  inline bool
263  operator!= (const ArcType& lhs,
264  const ArcType& rhs)
265  {
266  return static_cast<ArcType::enum_value>(lhs) != static_cast<ArcType::enum_value>(rhs);
267  }
268 
276  inline bool
277  operator!= (const ArcType& lhs,
278  const ArcType::enum_value& rhs)
279  {
280  return static_cast<ArcType::enum_value>(lhs) != rhs;
281  }
282 
290  inline bool
292  const ArcType& rhs)
293  {
294  return lhs != static_cast<ArcType::enum_value>(rhs);
295  }
296 
304  inline bool
305  operator!= (const ArcType& lhs,
306  const std::string& rhs)
307  {
308  return static_cast<const std::string&>(lhs) != rhs;
309  }
310 
318  inline bool
319  operator!= (const std::string& lhs,
320  const ArcType& rhs)
321  {
322  return lhs != static_cast<const std::string&>(rhs);
323  }
324 
332  template<class charT, class traits>
333  inline std::basic_ostream<charT,traits>&
334  operator<< (std::basic_ostream<charT,traits>& os,
335  const ArcType& enumeration)
336  {
337  return os << static_cast<const std::string&>(enumeration);
338  }
339 
347  template<class charT, class traits>
348  inline std::basic_istream<charT,traits>&
349  operator>> (std::basic_istream<charT,traits>& is,
350  ArcType& enumeration)
351  {
352  std::string value;
353  is >> value;
354  if (is)
355  {
356  try
357  {
358  enumeration = ArcType(value, false);
359  }
360  catch (const EnumerationException&)
361  {
362  is.setstate(std::ios::failbit);
363  }
364  }
365 
366  return is;
367  }
368 
369  }
370  }
371  }
372 }
373 
374 #endif // OME_XML_MODEL_ENUMS_ARCTYPE_H
375 
376 /*
377  * Local Variables:
378  * mode:C++
379  * End:
380  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:381
Hg.
Definition: ArcType.h:76
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:295
ArcType enumeration.
Definition: ArcType.h:69
enum_value
Enumeration values.
Definition: ArcType.h:73
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
ArcType(enum_value value)
Construct a ArcType enumeration by an enumeration value.
Definition: ArcType.cpp:75
Other.
Definition: ArcType.h:82
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: ArcType.cpp:170
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: ArcType.cpp:187
HgXe.
Definition: ArcType.h:80
std::map< std::string, ArcType::enum_value > string_map_type
String map type.
Definition: ArcType.h:150
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
Xe.
Definition: ArcType.h:78
std::map< ArcType::enum_value, std::string > value_map_type
Value map type.
Definition: ArcType.h:152
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: ArcType.cpp:153
const std::string * name
Enumeration name.
Definition: ArcType.h:182
enum_value value
Enumeration value.
Definition: ArcType.h:180
ArcType & operator=(const ArcType &rhs)
Assignment operator.
Definition: ArcType.h:120
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53