OME.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_OME_H
#define OME_XML_MODEL_OME_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/BinaryOnly.h>
#include <ome/xml/model/Rights.h>
#include <ome/xml/model/StructuredAnnotations.h>
#include <ome/xml/model/detail/OMEModelObject.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      // Forward declarations.
      class Dataset;
      class Experiment;
      class Experimenter;
      class ExperimenterGroup;
      class Image;
      class Instrument;
      class OMEModel;
      class Plate;
      class Project;
      class ROI;
      class Screen;

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

      public:
        OME();

        OME (const OME& copy);

        virtual
        ~OME ();

        static ome::compat::shared_ptr< OME>
        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:
        // -- OME API methods --

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

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

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

        void
        setUUID (ome::compat::shared_ptr<std::string>& uuid);

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

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

        void
        setCreator (ome::compat::shared_ptr<std::string>& creator);

        ome::compat::shared_ptr<ome::xml::model::Rights>
        getRights ();

        const ome::compat::shared_ptr<ome::xml::model::Rights>
        getRights () const;

        void
        setRights (ome::compat::shared_ptr<ome::xml::model::Rights>& rights);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type
        sizeOfProjectList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
        getProjectList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
        getProjectList () const;

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

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

        void
        setProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Project>& project);

        void
        addProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);

        void
        removeProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type
        sizeOfDatasetList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
        getDatasetList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
        getDatasetList () const;

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

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

        void
        setDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);

        void
        addDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);

        void
        removeDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type
        sizeOfExperimentList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
        getExperimentList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
        getExperimentList () const;

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

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

        void
        setExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);

        void
        addExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);

        void
        removeExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type
        sizeOfPlateList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
        getPlateList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
        getPlateList () const;

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

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

        void
        setPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Plate>& plate);

        void
        addPlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);

        void
        removePlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type
        sizeOfScreenList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
        getScreenList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
        getScreenList () const;

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

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

        void
        setScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Screen>& screen);

        void
        addScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);

        void
        removeScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type
        sizeOfExperimenterList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
        getExperimenterList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
        getExperimenterList () const;

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

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

        void
        setExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);

        void
        addExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);

        void
        removeExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);

        std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type
        sizeOfExperimenterGroupList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
        getExperimenterGroupList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
        getExperimenterGroupList () const;

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

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

        void
        setExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);

        void
        addExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);

        void
        removeExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type
        sizeOfInstrumentList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
        getInstrumentList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
        getInstrumentList () const;

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

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

        void
        setInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);

        void
        addInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);

        void
        removeInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);

        std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type
        sizeOfImageList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
        getImageList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
        getImageList () const;

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

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

        void
        setImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::Image>& image);

        void
        addImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);

        void
        removeImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);

        ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
        getStructuredAnnotations ();

        const ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
        getStructuredAnnotations () const;

        void
        setStructuredAnnotations (ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations);

        std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type
        sizeOfROIList () const;

        std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
        getROIList ();

        const std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
        getROIList () const;

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

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

        void
        setROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index,
                               ome::compat::shared_ptr<ome::xml::model::ROI>& roi);

        void
        addROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);

        void
        removeROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);

        ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
        getBinaryOnly ();

        const ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
        getBinaryOnly () const;

        void
        setBinaryOnly (ome::compat::shared_ptr<ome::xml::model::BinaryOnly>& binaryOnly);


        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_OME_H

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