/*
 * #%L
 * OME-FILES C++ library for image IO.
 * Copyright © 2006 - 2015 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%
 */

#ifndef OME_FILES_MODULO_H
#define OME_FILES_MODULO_H

#include <string>
#include <vector>
#include <sstream>

#include <ome/compat/cstdint.h>

namespace ome
{
  namespace files
  {

    /**
     * A subdimension of Z, C, or T.  Needed to support Modulo
     * annotations.  See
     * http://www.openmicroscopy.org/site/support/ome-model/developers/6d-7d-and-8d-storage.html
     */
    class Modulo {
    public:
      /// Size of the subdimension.
      typedef std::vector<std::string>::size_type size_type;

      /// Parent dimension being subdivided.
      std::string parentDimension;
      /// Start value.
      double start;
      /// Step size.
      double step;
      /// End value.
      double end;
      /// Type of the parent dimension.
      std::string parentType;
      /// Type of the subdimension.
      std::string type;
      /// Type description of the subdimension.
      std::string typeDescription;
      /// Unit of the subdimension.
      std::string unit;
      /// Labels along the subdimension.
      std::vector<std::string> labels;

      /**
       * Constructor.
       *
       * @param dimension the parent dimension.
       */
      Modulo(std::string dimension);

      /**
       * Get the size of this subdimension.
       *
       * This is the number of discrete samples along this dimension,
       * between the start and end points, separated by step size
       * increments.
       *
       * @returns the subdimension size.
       */
      size_type
      size() const;

      /**
       * Convert to XML string.
       *
       * The object is serialized to an XML text representation.
       * This is suitable for embedding in an
       * ome::xml::model::XMLAnnotation, for example.
       *
       * @returns a string containing the XML.
       * @copydoc ome::xml::meta::OMEXMLMetadata::dumpXML()
       */
      std::string
      toXMLAnnotation() const;
    };

    /**
     * Output Modulo to output stream.
     *
     * @param os the output stream.
     * @param modulo the Modulo to output.
     * @returns the output stream.
     */
    template<class charT, class traits>
    inline std::basic_ostream<charT,traits>&
    operator<< (std::basic_ostream<charT,traits>& os,
                const Modulo& modulo)
    {
      os << "parentDimension = " << modulo.parentDimension << '\n'
         << "start = " << modulo.start << '\n'
         << "step = " << modulo.step << '\n'
         << "end = " << modulo.end << '\n'
         << "parentType = " << modulo.parentType << '\n'
         << "type = " << modulo.type << '\n'
         << "typeDescription = " << modulo.typeDescription << '\n'
         << "unit = " << modulo.unit << '\n'
         << "labels = ";
      for (std::vector<std::string>::const_iterator i = modulo.labels.begin();
           i != modulo.labels.end();
           ++i)
        {
          os << *i;
          if (i + 1 != modulo.labels.end())
            os << ", ";
        }
      os << '\n';

      return os;
    }

  }
}

#endif // OME_FILES_MODULO_H

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