bioformats  5.1.8
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 namespace ome
58 {
59  namespace xml
60  {
61  namespace model
62  {
63  namespace enums
64  {
65 
69  class Marker
70  {
71  public:
74  {
81  };
82 
89 
104  Marker (const std::string& name, bool strict = true);
105 
111  Marker (const Marker& original);
112 
117  inline Marker&
118  operator= (const Marker& rhs)
119  {
120  this->value = rhs.value;
121  this->name = rhs.name;
122  return *this;
123  }
124 
130  inline
131  operator enum_value () const
132  {
133  return this->value;
134  }
135 
141  inline
142  operator const std::string& () const
143  {
144  return *this->name;
145  }
146 
148  typedef std::map<std::string, Marker::enum_value> string_map_type;
150  typedef std::map<Marker::enum_value, std::string> value_map_type;
151 
157  static const string_map_type&
158  strings();
159 
165  static const value_map_type&
166  values();
167 
168  private:
174  static const string_map_type&
176 
180  const std::string *name;
181  };
182 
190  inline bool
191  operator== (const Marker& lhs,
192  const Marker& rhs)
193  {
194  return static_cast<Marker::enum_value>(lhs) == static_cast<Marker::enum_value>(rhs);
195  }
196 
204  inline bool
205  operator== (const Marker& lhs,
206  const Marker::enum_value& rhs)
207  {
208  return static_cast<Marker::enum_value>(lhs) == rhs;
209  }
210 
218  inline bool
220  const Marker& rhs)
221  {
222  return lhs == static_cast<Marker::enum_value>(rhs);
223  }
224 
232  inline bool
233  operator== (const Marker& lhs,
234  const std::string& rhs)
235  {
236  return static_cast<const std::string&>(lhs) == rhs;
237  }
238 
246  inline bool
247  operator== (const std::string& lhs,
248  const Marker& rhs)
249  {
250  return lhs == static_cast<const std::string&>(rhs);
251  }
252 
260  inline bool
261  operator!= (const Marker& lhs,
262  const Marker& rhs)
263  {
264  return static_cast<Marker::enum_value>(lhs) != static_cast<Marker::enum_value>(rhs);
265  }
266 
274  inline bool
275  operator!= (const Marker& lhs,
276  const Marker::enum_value& rhs)
277  {
278  return static_cast<Marker::enum_value>(lhs) != rhs;
279  }
280 
288  inline bool
290  const Marker& rhs)
291  {
292  return lhs != static_cast<Marker::enum_value>(rhs);
293  }
294 
302  inline bool
303  operator!= (const Marker& lhs,
304  const std::string& rhs)
305  {
306  return static_cast<const std::string&>(lhs) != rhs;
307  }
308 
316  inline bool
317  operator!= (const std::string& lhs,
318  const Marker& rhs)
319  {
320  return lhs != static_cast<const std::string&>(rhs);
321  }
322 
330  template<class charT, class traits>
331  inline std::basic_ostream<charT,traits>&
332  operator<< (std::basic_ostream<charT,traits>& os,
333  const Marker& enumeration)
334  {
335  return os << static_cast<const std::string&>(enumeration);
336  }
337 
345  template<class charT, class traits>
346  inline std::basic_istream<charT,traits>&
347  operator>> (std::basic_istream<charT,traits>& is,
348  Marker& enumeration)
349  {
350  std::string value;
351  is >> value;
352  if (is)
353  {
354  try
355  {
356  enumeration = Marker(value, false);
357  }
358  catch (const EnumerationException&)
359  {
360  is.setstate(std::ios::failbit);
361  }
362  }
363 
364  return is;
365  }
366 
367  }
368  }
369  }
370 }
371 
372 #endif // OME_XML_MODEL_ENUMS_MARKER_H
373 
374 /*
375  * Local Variables:
376  * mode:C++
377  * End:
378  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:381
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:295
Arrow.
Definition: Marker.h:76
Square.
Definition: Marker.h:80
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: Marker.cpp:154
enum_value
Enumeration values.
Definition: Marker.h:73
Marker enumeration.
Definition: Marker.h:69
Circle.
Definition: Marker.h:78
std::map< std::string, Marker::enum_value > string_map_type
String map type.
Definition: Marker.h:148
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: Marker.cpp:138
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: Marker.cpp:170
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
std::map< Marker::enum_value, std::string > value_map_type
Value map type.
Definition: Marker.h:150
Marker(enum_value value)
Construct a Marker enumeration by an enumeration value.
Definition: Marker.cpp:75
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
enum_value value
Enumeration value.
Definition: Marker.h:178
const std::string * name
Enumeration name.
Definition: Marker.h:180
Marker & operator=(const Marker &rhs)
Assignment operator.
Definition: Marker.h:118
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53