Channel.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_CHANNEL_H
#define OME_XML_MODEL_CHANNEL_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/primitives/Quantity.h>

#include <ome/xml/model/DetectorSettings.h>
#include <ome/xml/model/FilterSet.h>
#include <ome/xml/model/LightPath.h>
#include <ome/xml/model/LightSourceSettings.h>
#include <ome/xml/model/Pixels.h>
#include <ome/xml/model/detail/OMEModelObject.h>
#include <ome/xml/model/enums/AcquisitionMode.h>
#include <ome/xml/model/enums/ContrastMethod.h>
#include <ome/xml/model/enums/IlluminationType.h>
#include <ome/xml/model/enums/UnitsLength.h>
#include <ome/xml/model/primitives/Color.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 OMEModel;

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

      public:
        Channel();

        Channel (const Channel& copy);

        virtual
        ~Channel ();

        static ome::compat::shared_ptr< Channel>
        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;

      private:
        Channel&
        operator= (const Channel&);

      public:
        // -- OMEModelObject API methods --

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

      public:
        // -- Channel API methods --

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

        ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
        getPinholeSize ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
        getPinholeSize () const;

        void
        setPinholeSize (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& pinholeSize);

        ome::compat::shared_ptr<std::string>
        getName ();

        const ome::compat::shared_ptr<std::string>
        getName () const;

        void
        setName (ome::compat::shared_ptr<std::string>& name);

        ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>
        getAcquisitionMode ();

        const ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>
        getAcquisitionMode () const;

        void
        setAcquisitionMode (ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>& acquisitionMode);

        ome::compat::shared_ptr<ome::xml::model::primitives::Color>
        getColor ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
        getColor () const;

        void
        setColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& color);

        ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>
        getContrastMethod ();

        const ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>
        getContrastMethod () const;

        void
        setContrastMethod (ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>& contrastMethod);

        ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
        getExcitationWavelength ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
        getExcitationWavelength () const;

        void
        setExcitationWavelength (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& excitationWavelength);

        ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>
        getIlluminationType ();

        const ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>
        getIlluminationType () const;

        void
        setIlluminationType (ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>& illuminationType);

        ome::compat::shared_ptr<std::string>
        getFluor ();

        const ome::compat::shared_ptr<std::string>
        getFluor () const;

        void
        setFluor (ome::compat::shared_ptr<std::string>& fluor);

        ome::compat::shared_ptr<int32_t>
        getPockelCellSetting ();

        const ome::compat::shared_ptr<int32_t>
        getPockelCellSetting () const;

        void
        setPockelCellSetting (ome::compat::shared_ptr<int32_t>& pockelCellSetting);

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

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

        void
        setNDFilter (ome::compat::shared_ptr<double>& ndFilter);

        ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
        getEmissionWavelength ();

        const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
        getEmissionWavelength () const;

        void
        setEmissionWavelength (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& emissionWavelength);

        const std::string&
        getID () const;

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

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

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

        void
        setSamplesPerPixel (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& samplesPerPixel);

        ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>
        getLightSourceSettings ();

        const ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>
        getLightSourceSettings () const;

        void
        setLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);

        ome::compat::shared_ptr<ome::xml::model::DetectorSettings>
        getDetectorSettings ();

        const ome::compat::shared_ptr<ome::xml::model::DetectorSettings>
        getDetectorSettings () const;

        void
        setDetectorSettings (ome::compat::shared_ptr<ome::xml::model::DetectorSettings>& detectorSettings);

        ome::compat::weak_ptr<ome::xml::model::FilterSet>
        getLinkedFilterSet ();

        const ome::compat::weak_ptr<ome::xml::model::FilterSet>
        getLinkedFilterSet () const;

        void
        linkFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);

        void
        unlinkFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);

        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);

        ome::compat::shared_ptr<ome::xml::model::LightPath>
        getLightPath ();

        const ome::compat::shared_ptr<ome::xml::model::LightPath>
        getLightPath () const;

        void
        setLightPath (ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath);

        ome::compat::weak_ptr<ome::xml::model::Pixels>
        getPixels ();

        const ome::compat::weak_ptr<ome::xml::model::Pixels>
        getPixels () const;

        void
        setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);

        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_CHANNEL_H

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