DimensionOrder.h

/*
 * #%L
 * OME-XML C++ library for working with OME-XML metadata structures.
 * %%
 * Copyright © 2006 - 2016 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

/*─────────────────────────────────────────────────────────────────────────────
 *
 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
 *
 *─────────────────────────────────────────────────────────────────────────────
 */

#ifndef OME_XML_MODEL_ENUMS_DIMENSIONORDER_H
#define OME_XML_MODEL_ENUMS_DIMENSIONORDER_H

#include <ostream>
#include <map>
#include <string>

#include <ome/common/log.h>

#include <ome/xml/model/enums/EnumerationException.h>

// All values in the DimensionOrder enumeration.
#define OME_XML_MODEL_ENUMS_DIMENSIONORDER_VALUES (XYZCT)(XYZTC)(XYCTZ)(XYCZT)(XYTCZ)(XYTZC)

namespace ome
{
  namespace xml
  {
    namespace model
    {
      namespace enums
      {

        class DimensionOrder
        {
        public:
          enum enum_value
            {
              XYZCT,
              XYZTC,
              XYCTZ,
              XYCZT,
              XYTCZ,
              XYTZC
            };

          DimensionOrder (enum_value value);

          DimensionOrder (const std::string& name, bool strict = true);

          DimensionOrder (const DimensionOrder& original);

          inline DimensionOrder&
          operator=  (const DimensionOrder& rhs)
          {
            this->value = rhs.value;
            this->name = rhs.name;
            return *this;
          }

          inline
          operator enum_value () const
          {
            return this->value;
          }

          inline
          operator const std::string& () const
          {
            return *this->name;
          }

          typedef std::map<std::string, DimensionOrder::enum_value> string_map_type;
          typedef std::map<DimensionOrder::enum_value, std::string> value_map_type;

          static const string_map_type&
          strings();

          static const value_map_type&
          values();

        private:
          static const string_map_type&
          lowercase_strings();

          enum_value         value;
          const std::string *name;
        };

        inline bool
        operator== (const DimensionOrder& lhs,
                    const DimensionOrder& rhs)
        {
          return static_cast<DimensionOrder::enum_value>(lhs) == static_cast<DimensionOrder::enum_value>(rhs);
        }

        inline bool
        operator== (const DimensionOrder& lhs,
                    const DimensionOrder::enum_value& rhs)
        {
          return static_cast<DimensionOrder::enum_value>(lhs) == rhs;
        }

        inline bool
        operator== (const DimensionOrder::enum_value& lhs,
                    const DimensionOrder& rhs)
        {
          return lhs == static_cast<DimensionOrder::enum_value>(rhs);
        }

        inline bool
        operator== (const DimensionOrder& lhs,
                    const std::string& rhs)
        {
          return static_cast<const std::string&>(lhs) == rhs;
        }

        inline bool
        operator== (const std::string& lhs,
                    const DimensionOrder& rhs)
        {
          return lhs == static_cast<const std::string&>(rhs);
        }

        inline bool
        operator!= (const DimensionOrder& lhs,
                    const DimensionOrder& rhs)
        {
          return static_cast<DimensionOrder::enum_value>(lhs) != static_cast<DimensionOrder::enum_value>(rhs);
        }

        inline bool
        operator!= (const DimensionOrder& lhs,
                    const DimensionOrder::enum_value& rhs)
        {
          return static_cast<DimensionOrder::enum_value>(lhs) != rhs;
        }

        inline bool
        operator!= (const DimensionOrder::enum_value& lhs,
                    const DimensionOrder& rhs)
        {
          return lhs != static_cast<DimensionOrder::enum_value>(rhs);
        }

        inline bool
        operator!= (const DimensionOrder& lhs,
                    const std::string& rhs)
        {
          return static_cast<const std::string&>(lhs) != rhs;
        }

        inline bool
        operator!= (const std::string& lhs,
                    const DimensionOrder& rhs)
        {
          return lhs != static_cast<const std::string&>(rhs);
        }

        template<class charT, class traits>
        inline std::basic_ostream<charT,traits>&
        operator<< (std::basic_ostream<charT,traits>& os,
                    const DimensionOrder& enumeration)
        {
          return os << static_cast<const std::string&>(enumeration);
        }

        template<class charT, class traits>
        inline std::basic_istream<charT,traits>&
        operator>> (std::basic_istream<charT,traits>& is,
                    DimensionOrder& enumeration)
        {
          std::string value;
          is >> value;
          if (is)
            {
              try
                {
                  enumeration = DimensionOrder(value, false);
                }
              catch (const EnumerationException&)
                {
                  is.setstate(std::ios::failbit);
                }
            }

          return is;
        }

      }
    }
  }
}

#endif // OME_XML_MODEL_ENUMS_DIMENSIONORDER_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */