ome-xml  5.2.4
UnitsPower.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_UNITSPOWER_H
47 #define OME_XML_MODEL_ENUMS_UNITSPOWER_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 #include <ome/xml/model/primitives/Quantity.h>
58 
59 // All values in the UnitsPower enumeration.
60 #define OME_XML_MODEL_ENUMS_UNITSPOWER_VALUES (YOTTAWATT)(ZETTAWATT)(EXAWATT)(PETAWATT)(TERAWATT)(GIGAWATT)(MEGAWATT)(KILOWATT)(HECTOWATT)(DECAWATT)(WATT)(DECIWATT)(CENTIWATT)(MILLIWATT)(MICROWATT)(NANOWATT)(PICOWATT)(FEMTOWATT)(ATTOWATT)(ZEPTOWATT)(YOCTOWATT)
61 
62 namespace ome
63 {
64  namespace xml
65  {
66  namespace model
67  {
68  namespace enums
69  {
70 
74  class UnitsPower
75  {
76  public:
79  {
164  };
165 
172 
187  UnitsPower (const std::string& name, bool strict = true);
188 
194  UnitsPower (const UnitsPower& original);
195 
200  inline UnitsPower&
201  operator= (const UnitsPower& rhs)
202  {
203  this->value = rhs.value;
204  this->name = rhs.name;
205  return *this;
206  }
207 
213  inline
214  operator enum_value () const
215  {
216  return this->value;
217  }
218 
224  inline
225  operator const std::string& () const
226  {
227  return *this->name;
228  }
229 
231  typedef std::map<std::string, UnitsPower::enum_value> string_map_type;
233  typedef std::map<UnitsPower::enum_value, std::string> value_map_type;
234 
240  static const string_map_type&
241  strings();
242 
248  static const value_map_type&
249  values();
250 
251  private:
257  static const string_map_type&
259 
263  const std::string *name;
264  };
265 
273  inline bool
275  const UnitsPower& rhs)
276  {
277  return static_cast<UnitsPower::enum_value>(lhs) == static_cast<UnitsPower::enum_value>(rhs);
278  }
279 
287  inline bool
289  const UnitsPower::enum_value& rhs)
290  {
291  return static_cast<UnitsPower::enum_value>(lhs) == rhs;
292  }
293 
301  inline bool
303  const UnitsPower& rhs)
304  {
305  return lhs == static_cast<UnitsPower::enum_value>(rhs);
306  }
307 
315  inline bool
317  const std::string& rhs)
318  {
319  return static_cast<const std::string&>(lhs) == rhs;
320  }
321 
329  inline bool
330  operator== (const std::string& lhs,
331  const UnitsPower& rhs)
332  {
333  return lhs == static_cast<const std::string&>(rhs);
334  }
335 
343  inline bool
345  const UnitsPower& rhs)
346  {
347  return static_cast<UnitsPower::enum_value>(lhs) != static_cast<UnitsPower::enum_value>(rhs);
348  }
349 
357  inline bool
359  const UnitsPower::enum_value& rhs)
360  {
361  return static_cast<UnitsPower::enum_value>(lhs) != rhs;
362  }
363 
371  inline bool
373  const UnitsPower& rhs)
374  {
375  return lhs != static_cast<UnitsPower::enum_value>(rhs);
376  }
377 
385  inline bool
387  const std::string& rhs)
388  {
389  return static_cast<const std::string&>(lhs) != rhs;
390  }
391 
399  inline bool
400  operator!= (const std::string& lhs,
401  const UnitsPower& rhs)
402  {
403  return lhs != static_cast<const std::string&>(rhs);
404  }
405 
413  template<class charT, class traits>
414  inline std::basic_ostream<charT,traits>&
415  operator<< (std::basic_ostream<charT,traits>& os,
416  const UnitsPower& enumeration)
417  {
418  return os << static_cast<const std::string&>(enumeration);
419  }
420 
428  template<class charT, class traits>
429  inline std::basic_istream<charT,traits>&
430  operator>> (std::basic_istream<charT,traits>& is,
431  UnitsPower& enumeration)
432  {
433  std::string value;
434  is >> value;
435  if (is)
436  {
437  try
438  {
439  enumeration = UnitsPower(value, false);
440  }
441  catch (const EnumerationException&)
442  {
443  is.setstate(std::ios::failbit);
444  }
445  }
446 
447  return is;
448  }
449 
450  }
451  }
452  }
453 }
454 
455 #include <ome/xml/model/enums/UnitsPowerConvert.h>
456 
457 #endif // OME_XML_MODEL_ENUMS_UNITSPOWER_H
458 
459 /*
460  * Local Variables:
461  * mode:C++
462  * End:
463  */
std::basic_istream< charT, traits > & operator>>(std::basic_istream< charT, traits > &is, AcquisitionMode &enumeration)
Set AcquisitionMode from input stream.
Definition: AcquisitionMode.h:390
bool operator!=(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for non-equality.
Definition: AcquisitionMode.h:304
terawatt unit.
Definition: UnitsPower.h:99
picowatt unit.
Definition: UnitsPower.h:147
milliwatt unit.
Definition: UnitsPower.h:135
gigawatt unit.
Definition: UnitsPower.h:103
enum_value value
Enumeration value.
Definition: UnitsPower.h:261
kilowatt unit.
Definition: UnitsPower.h:111
EnumerationException is thrown when an enumeration is invalid or not found.
Definition: EnumerationException.h:74
static const string_map_type & lowercase_strings()
Get a map of valid lowercased string names and enum values.
Definition: UnitsPower.cpp:206
UnitsPower & operator=(const UnitsPower &rhs)
Assignment operator.
Definition: UnitsPower.h:201
attowatt unit.
Definition: UnitsPower.h:155
watt unit.
Definition: UnitsPower.h:123
deciwatt unit.
Definition: UnitsPower.h:127
hectowatt unit.
Definition: UnitsPower.h:115
std::map< UnitsPower::enum_value, std::string > value_map_type
Value map type.
Definition: UnitsPower.h:233
Open Microscopy Environment C++ implementation.
static const string_map_type & strings()
Get a map of valid string names and enum values.
Definition: UnitsPower.cpp:138
petawatt unit.
Definition: UnitsPower.h:95
bool operator==(const AcquisitionMode &lhs, const AcquisitionMode &rhs)
Compare two AcquisitionMode objects for equality.
Definition: AcquisitionMode.h:234
UnitsPower(enum_value value)
Construct a UnitsPower enumeration by an enumeration value.
Definition: UnitsPower.cpp:75
centiwatt unit.
Definition: UnitsPower.h:131
exawatt unit.
Definition: UnitsPower.h:91
enum_value
Enumeration values.
Definition: UnitsPower.h:78
std::map< std::string, UnitsPower::enum_value > string_map_type
String map type.
Definition: UnitsPower.h:231
femtowatt unit.
Definition: UnitsPower.h:151
nanowatt unit.
Definition: UnitsPower.h:143
const std::string * name
Enumeration name.
Definition: UnitsPower.h:263
megawatt unit.
Definition: UnitsPower.h:107
UnitsPower enumeration.
Definition: UnitsPower.h:74
yottawatt unit.
Definition: UnitsPower.h:83
microwatt unit.
Definition: UnitsPower.h:139
static const value_map_type & values()
Get a map of valid enum values and string names.
Definition: UnitsPower.cpp:172
decawatt unit.
Definition: UnitsPower.h:119
yoctowatt unit.
Definition: UnitsPower.h:163
zeptowatt unit.
Definition: UnitsPower.h:159
zettawatt unit.
Definition: UnitsPower.h:87