Image.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_IMAGE_H
#define OME_XML_MODEL_IMAGE_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/xml/model/primitives/Quantity.h>

#include <ome/xml/model/Experiment.h>
#include <ome/xml/model/Experimenter.h>
#include <ome/xml/model/ExperimenterGroup.h>
#include <ome/xml/model/ImagingEnvironment.h>
#include <ome/xml/model/Instrument.h>
#include <ome/xml/model/ObjectiveSettings.h>
#include <ome/xml/model/Pixels.h>
#include <ome/xml/model/StageLabel.h>
#include <ome/xml/model/detail/OMEModelObject.h>
#include <ome/xml/model/primitives/Timestamp.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      // Forward declarations.
      class Annotation;
      class Dataset;
      class Folder;
      class MicrobeamManipulation;
      class OMEModel;
      class ROI;
      class WellSample;

      class Image : public detail::OMEModelObject
      {
      private:
        class Impl;
        std::shared_ptr<Impl> impl;

      public:
        Image();

        Image (const Image& copy);

        virtual
        ~Image ();

        static std::shared_ptr<Image>
        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;

        Image&
        operator= (const Image&) = delete;

        // -- OMEModelObject API methods --

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

      public:
        // -- Image API methods --

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

        const std::string&
        getID () const;

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

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

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

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

        std::shared_ptr<ome::xml::model::primitives::Timestamp>
        getAcquisitionDate ();

        const std::shared_ptr<ome::xml::model::primitives::Timestamp>
        getAcquisitionDate () const;

        void
        setAcquisitionDate (std::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);

        std::weak_ptr<ome::xml::model::Experimenter>
        getLinkedExperimenter ();

        const std::weak_ptr<ome::xml::model::Experimenter>
        getLinkedExperimenter () const;

        void
        linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);

        void
        unlinkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);

        std::shared_ptr<std::string>
        getDescription ();

        const std::shared_ptr<std::string>
        getDescription () const;

        void
        setDescription (std::shared_ptr<std::string>& description);

        std::weak_ptr<ome::xml::model::Experiment>
        getLinkedExperiment ();

        const std::weak_ptr<ome::xml::model::Experiment>
        getLinkedExperiment () const;

        void
        linkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);

        void
        unlinkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);

        std::weak_ptr<ome::xml::model::ExperimenterGroup>
        getLinkedExperimenterGroup ();

        const std::weak_ptr<ome::xml::model::ExperimenterGroup>
        getLinkedExperimenterGroup () const;

        void
        linkExperimenterGroup (std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);

        void
        unlinkExperimenterGroup (std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);

        std::weak_ptr<ome::xml::model::Instrument>
        getLinkedInstrument ();

        const std::weak_ptr<ome::xml::model::Instrument>
        getLinkedInstrument () const;

        void
        linkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);

        void
        unlinkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);

        std::shared_ptr<ome::xml::model::ObjectiveSettings>
        getObjectiveSettings ();

        const std::shared_ptr<ome::xml::model::ObjectiveSettings>
        getObjectiveSettings () const;

        void
        setObjectiveSettings (std::shared_ptr<ome::xml::model::ObjectiveSettings>& objectiveSettings);

        std::shared_ptr<ome::xml::model::ImagingEnvironment>
        getImagingEnvironment ();

        const std::shared_ptr<ome::xml::model::ImagingEnvironment>
        getImagingEnvironment () const;

        void
        setImagingEnvironment (std::shared_ptr<ome::xml::model::ImagingEnvironment>& imagingEnvironment);

        std::shared_ptr<ome::xml::model::StageLabel>
        getStageLabel ();

        const std::shared_ptr<ome::xml::model::StageLabel>
        getStageLabel () const;

        void
        setStageLabel (std::shared_ptr<ome::xml::model::StageLabel>& stageLabel);

        std::shared_ptr<ome::xml::model::Pixels>
        getPixels ();

        const std::shared_ptr<ome::xml::model::Pixels>
        getPixels () const;

        void
        setPixels (std::shared_ptr<ome::xml::model::Pixels>& pixels);

        OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type
        sizeOfLinkedROIList () const;

        OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type
        getLinkedROIList () const;

        const std::weak_ptr<ome::xml::model::ROI>&
        getLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index) const;

        const std::weak_ptr<ome::xml::model::ROI>&
        setLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index,
                                     const std::shared_ptr<ome::xml::model::ROI>& roi);

        bool
        linkROI (const std::shared_ptr<ome::xml::model::ROI>& roi);

        bool
        unlinkROI (const std::shared_ptr<ome::xml::model::ROI>& roi);

        OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, std::weak_ptr>::type::size_type
        sizeOfLinkedMicrobeamManipulationList () const;

        OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, std::weak_ptr>::type
        getLinkedMicrobeamManipulationList () const;

        const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
        getLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, std::weak_ptr>::type::size_type index) const;

        const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
        setLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, std::weak_ptr>::type::size_type index,
                                     const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);

        bool
        linkMicrobeamManipulation (const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);

        bool
        unlinkMicrobeamManipulation (const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);

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

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

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

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

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

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

        OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type
        sizeOfLinkedDatasetList () const;

        OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type
        getLinkedDatasetList () const;

        const std::weak_ptr<ome::xml::model::Dataset>&
        getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index) const;

        const std::weak_ptr<ome::xml::model::Dataset>&
        setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index,
                                     const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);

        bool
        linkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);

        bool
        unlinkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);

        OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type
        sizeOfLinkedFolderList () const;

        OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type
        getLinkedFolderList () const;

        const std::weak_ptr<ome::xml::model::Folder>&
        getLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index) const;

        const std::weak_ptr<ome::xml::model::Folder>&
        setLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index,
                                     const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);

        bool
        linkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);

        bool
        unlinkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);

        OMEModelObject::indexed_container<ome::xml::model::WellSample, std::weak_ptr>::type::size_type
        sizeOfLinkedWellSampleList () const;

        OMEModelObject::indexed_container<ome::xml::model::WellSample, std::weak_ptr>::type
        getLinkedWellSampleList () const;

        const std::weak_ptr<ome::xml::model::WellSample>&
        getLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, std::weak_ptr>::type::size_type index) const;

        const std::weak_ptr<ome::xml::model::WellSample>&
        setLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, std::weak_ptr>::type::size_type index,
                                     const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);

        bool
        linkWellSample (const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);

        bool
        unlinkWellSample (const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);

      protected:
        // Documented in base class.
        virtual void
        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_IMAGE_H

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