bioformats  5.1.8
DimensionOrder.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_DIMENSIONORDER_H
47 #define OME_XML_MODEL_ENUMS_DIMENSIONORDER_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 
70  {
71  public:
74  {
87  };
88 
95 
110  DimensionOrder (const std::string& name, bool strict = true);
111 
117  DimensionOrder (const DimensionOrder& original);
118 
123  inline DimensionOrder&
125  {
126  this->value = rhs.value;
127  this->name = rhs.name;
128  return *this;
129  }
130 
136  inline
137  operator enum_value () const
138  {
139  return this->value;
140  }
141 
147  inline
148  operator const std::string& () const
149  {
150  return *this->name;
151  }
152 
154  typedef std::map<std::string, DimensionOrder::enum_value> string_map_type;
156  typedef std::map<DimensionOrder::enum_value, std::string> value_map_type;
157 
163  static const string_map_type&
164  strings();
165 
171  static const value_map_type&
172  values();
173 
174  private:
180  static const string_map_type&
182 
186  const std::string *name;
187  };
188 
196  inline bool
198  const DimensionOrder& rhs)
199  {
200  return static_cast<DimensionOrder::enum_value>(lhs) == static_cast<DimensionOrder::enum_value>(rhs);
201  }
202 
210  inline bool
212  const DimensionOrder::enum_value& rhs)
213  {
214  return static_cast<DimensionOrder::enum_value>(lhs) == rhs;
215  }
216 
224  inline bool
226  const DimensionOrder& rhs)
227  {
228  return lhs == static_cast<DimensionOrder::enum_value>(rhs);
229  }
230 
238  inline bool
240  const std::string& rhs)
241  {
242  return static_cast<const std::string&>(lhs) == rhs;
243  }
244 
252  inline bool
253  operator== (const std::string& lhs,
254  const DimensionOrder& rhs)
255  {
256  return lhs == static_cast<const std::string&>(rhs);
257  }
258 
266  inline bool
268  const DimensionOrder& rhs)
269  {
270  return static_cast<DimensionOrder::enum_value>(lhs) != static_cast<DimensionOrder::enum_value>(rhs);
271  }
272 
280  inline bool
282  const DimensionOrder::enum_value& rhs)
283  {
284  return static_cast<DimensionOrder::enum_value>(lhs) != rhs;
285  }
286 
294  inline bool
296  const DimensionOrder& rhs)
297  {
298  return lhs != static_cast<DimensionOrder::enum_value>(rhs);
299  }
300 
308  inline bool
310  const std::string& rhs)
311  {
312  return static_cast<const std::string&>(lhs) != rhs;
313  }
314 
322  inline bool
323  operator!= (const std::string& lhs,
324  const DimensionOrder& rhs)
325  {
326  return lhs != static_cast<const std::string&>(rhs);
327  }
328 
336  template<class charT, class traits>
337  inline std::basic_ostream<charT,traits>&
338  operator<< (std::basic_ostream<charT,traits>& os,
339  const DimensionOrder& enumeration)
340  {
341  return os << static_cast<const std::string&>(enumeration);
342  }
343 
351  template<class charT, class traits>
352  inline std::basic_istream<charT,traits>&
353  operator>> (std::basic_istream<charT,traits>& is,
354  DimensionOrder& enumeration)
355  {
356  std::string value;
357  is >> value;
358  if (is)
359  {
360  try
361  {
362  enumeration = DimensionOrder(value, false);
363  }
364  catch (const EnumerationException&)
365  {
366  is.setstate(std::ios::failbit);
367  }
368  }
369 
370  return is;
371  }
372 
373  }
374  }
375  }
376 }
377 
378 #endif // OME_XML_MODEL_ENUMS_DIMENSIONORDER_H
379 
380 /*
381  * Local Variables:
382  * mode:C++
383  * End:
384  */
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
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: DimensionOrder.cpp:176
enum_value
Enumeration values.
Definition: DimensionOrder.h:73
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
DimensionOrder & operator=(const DimensionOrder &rhs)
Assignment operator.
Definition: DimensionOrder.h:124
XYCTZ.
Definition: DimensionOrder.h:80
XYTZC.
Definition: DimensionOrder.h:86
DimensionOrder(enum_value value)
Construct a DimensionOrder enumeration by an enumeration value.
Definition: DimensionOrder.cpp:75
DimensionOrder enumeration.
Definition: DimensionOrder.h:69
const std::string * name
Enumeration name.
Definition: DimensionOrder.h:186
std::map< DimensionOrder::enum_value, std::string > value_map_type
Value map type.
Definition: DimensionOrder.h:156
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
XYZCT.
Definition: DimensionOrder.h:76
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:225
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: DimensionOrder.cpp:157
XYTCZ.
Definition: DimensionOrder.h:84
enum_value value
Enumeration value.
Definition: DimensionOrder.h:184
XYZTC.
Definition: DimensionOrder.h:78
std::map< std::string, DimensionOrder::enum_value > string_map_type
String map type.
Definition: DimensionOrder.h:154
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: DimensionOrder.cpp:138
Boost.Log compatibility.
XYCZT.
Definition: DimensionOrder.h:82
Xerces-C modern C++ wrapper.
Definition: Base.h:53