Pixels.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_PIXELS_H
#define OME_XML_MODEL_PIXELS_H

#include <algorithm>
#include <list>
#include <stdexcept>
#include <string>
#include <vector>

#include <ome/common/log.h>

#include <ome/common/xml/dom/Document.h>
#include <ome/common/xml/dom/Element.h>
#include <ome/common/xml/dom/Node.h>
#include <ome/common/xml/dom/NodeList.h>

#include <ome/xml/model/MetadataOnly.h>
#include <ome/xml/model/detail/OMEModelObject.h>
#include <ome/xml/model/enums/DimensionOrder.h>
#include <ome/xml/model/enums/PixelType.h>
#include <ome/xml/model/primitives/PositiveFloat.h>
#include <ome/xml/model/primitives/PositiveInteger.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      // Forward declarations.
      class Annotation;
      class BinData;
      class Channel;
      class OMEModel;
      class Plane;
      class TiffData;

      class Pixels : public detail::OMEModelObject
      {
      private:
        class Impl;
        ome::compat::shared_ptr<Impl> impl;

      public:
        Pixels();

        Pixels (const Pixels& copy);

        virtual
        ~Pixels ();

        static ome::compat::shared_ptr< Pixels>
        create(const common::xml::dom::Element& element,
               ome::xml::model::OMEModel& model);

        // Documented in superclass.
        const std::string&
        elementName() const;

        // Documented in superclass.
        bool
        validElementName(const std::string& name) const;


        // -- OMEModelObject API methods --

        virtual void
        update(const common::xml::dom::Element&  element,
               ome::xml::model::OMEModel& model);

      public:
        // -- Pixels API methods --

        bool
        link (ome::compat::shared_ptr<Reference>& reference,
              ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);

        const ome::xml::model::primitives::PositiveInteger&
        getSizeT () const;

        void
        setSizeT (const ome::xml::model::primitives::PositiveInteger& sizeT);

        ome::xml::model::enums::DimensionOrder&
        getDimensionOrder ();

        const ome::xml::model::enums::DimensionOrder&
        getDimensionOrder () const;

        void
        setDimensionOrder (const ome::xml::model::enums::DimensionOrder& dimensionOrder);

        ome::compat::shared_ptr<double>
        getTimeIncrement ();

        const ome::compat::shared_ptr<double>
        getTimeIncrement () const;

        void
        setTimeIncrement (ome::compat::shared_ptr<double>& timeIncrement);

        ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeY ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeY () const;

        void
        setPhysicalSizeY (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeY);

        ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeX ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeX () const;

        void
        setPhysicalSizeX (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeX);

        ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeZ ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
        getPhysicalSizeZ () const;

        void
        setPhysicalSizeZ (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeZ);

        const ome::xml::model::primitives::PositiveInteger&
        getSizeX () const;

        void
        setSizeX (const ome::xml::model::primitives::PositiveInteger& sizeX);

        const ome::xml::model::primitives::PositiveInteger&
        getSizeY () const;

        void
        setSizeY (const ome::xml::model::primitives::PositiveInteger& sizeY);

        const ome::xml::model::primitives::PositiveInteger&
        getSizeZ () const;

        void
        setSizeZ (const ome::xml::model::primitives::PositiveInteger& sizeZ);

        ome::compat::shared_ptr<bool>
        getBigEndian ();

        const ome::compat::shared_ptr<bool>
        getBigEndian () const;

        void
        setBigEndian (ome::compat::shared_ptr<bool>& bigEndian);

        ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
        getSignificantBits ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
        getSignificantBits () const;

        void
        setSignificantBits (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& significantBits);

        const ome::xml::model::primitives::PositiveInteger&
        getSizeC () const;

        void
        setSizeC (const ome::xml::model::primitives::PositiveInteger& sizeC);

        ome::xml::model::enums::PixelType&
        getType ();

        const ome::xml::model::enums::PixelType&
        getType () const;

        void
        setType (const ome::xml::model::enums::PixelType& type);

        const std::string&
        getID () const;

        void
        setID (const std::string& id);

        ome::compat::shared_ptr<bool>
        getInterleaved ();

        const ome::compat::shared_ptr<bool>
        getInterleaved () const;

        void
        setInterleaved (ome::compat::shared_ptr<bool>& interleaved);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type
        sizeOfChannelList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
        getChannelList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
        getChannelList () const;

        ome::compat::shared_ptr<ome::xml::model::Channel>&
        getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index);

        const ome::compat::shared_ptr<ome::xml::model::Channel>&
        getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index) const;

        void
        setChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Channel>& channel);

        void
        addChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);

        void
        removeChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);

        std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
        sizeOfBinDataList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
        getBinDataList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
        getBinDataList () const;

        ome::compat::shared_ptr<ome::xml::model::BinData>&
        getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);

        const ome::compat::shared_ptr<ome::xml::model::BinData>&
        getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index) const;

        void
        setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::BinData>& binData);

        void
        addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);

        void
        removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);

        std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type
        sizeOfTiffDataList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
        getTiffDataList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
        getTiffDataList () const;

        ome::compat::shared_ptr<ome::xml::model::TiffData>&
        getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index);

        const ome::compat::shared_ptr<ome::xml::model::TiffData>&
        getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index) const;

        void
        setTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);

        void
        addTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);

        void
        removeTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);

        ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
        getMetadataOnly ();

        const ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
        getMetadataOnly () const;

        void
        setMetadataOnly (ome::compat::shared_ptr<ome::xml::model::MetadataOnly>& metadataOnly);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type
        sizeOfPlaneList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
        getPlaneList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
        getPlaneList () const;

        ome::compat::shared_ptr<ome::xml::model::Plane>&
        getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index);

        const ome::compat::shared_ptr<ome::xml::model::Plane>&
        getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index) const;

        void
        setPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Plane>& plane);

        void
        addPlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);

        void
        removePlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);

        OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
        sizeOfLinkedAnnotationList () const;

        OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
        getLinkedAnnotationList () const;

        const ome::compat::weak_ptr<ome::xml::model::Annotation>&
        getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;

        const ome::compat::weak_ptr<ome::xml::model::Annotation>&
        setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);

        bool
        linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);

        bool
        unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);


        virtual common::xml::dom::Element
        asXMLElement (common::xml::dom::Document& document) const;


      protected:
        // Documented in base class.
        virtual common::xml::dom::Element
        asXMLElementInternal (common::xml::dom::Document& document,
                              common::xml::dom::Element&  element) const;

      public:
       // Documented in superclass.
       const std::string&
       getXMLNamespace() const;
      };

    }
  }
}

#endif // OME_XML_MODEL_PIXELS_H

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