Annotation.h

/*
 * #%L
 * OME-XML C++ library for working with OME-XML metadata structures.
 * %%
 * 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%
 */

/*─────────────────────────────────────────────────────────────────────────────
 *
 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
 *
 *─────────────────────────────────────────────────────────────────────────────
 */

#ifndef OME_XML_MODEL_ANNOTATION_H
#define OME_XML_MODEL_ANNOTATION_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/detail/OMEModelObject.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      // Forward declarations.
      class Channel;
      class Dataset;
      class Experimenter;
      class ExperimenterGroup;
      class Image;
      class OMEModel;
      class Pixels;
      class Plane;
      class Plate;
      class PlateAcquisition;
      class Project;
      class ROI;
      class Reagent;
      class Screen;
      class Well;
      class WellSample;

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

      public:
        Annotation();

        Annotation (const Annotation& copy);

        virtual
        ~Annotation ();


        // 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:
        // -- Annotation 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>
        getNamespace ();

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

        void
        setNamespace (ome::compat::shared_ptr<std::string>& namespace_);

        const std::string&
        getID () const;

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

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

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

        void
        setAnnotator (ome::compat::shared_ptr<std::string>& annotator);

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

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

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

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

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Image>&
        setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);

        bool
        linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);

        bool
        unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Pixels>&
        setLinkedPixels (OMEModelObject::indexed_container<ome::xml::model::Pixels, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);

        bool
        linkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);

        bool
        unlinkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Plane>&
        setLinkedPlane (OMEModelObject::indexed_container<ome::xml::model::Plane, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);

        bool
        linkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);

        bool
        unlinkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Channel>&
        setLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);

        bool
        linkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);

        bool
        unlinkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Project>&
        setLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);

        bool
        linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);

        bool
        unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
        setLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);

        bool
        linkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);

        bool
        unlinkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);

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

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

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

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

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

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

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
        setLinkedExperimenter (OMEModelObject::indexed_container<ome::xml::model::Experimenter, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);

        bool
        linkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);

        bool
        unlinkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);

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

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

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

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

        bool
        linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);

        bool
        unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Plate>&
        setLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);

        bool
        linkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);

        bool
        unlinkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Reagent>&
        setLinkedReagent (OMEModelObject::indexed_container<ome::xml::model::Reagent, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);

        bool
        linkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);

        bool
        unlinkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Screen>&
        setLinkedScreen (OMEModelObject::indexed_container<ome::xml::model::Screen, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);

        bool
        linkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);

        bool
        unlinkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
        setLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);

        bool
        linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);

        bool
        unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);

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

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

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

        const ome::compat::weak_ptr<ome::xml::model::Well>&
        setLinkedWell (OMEModelObject::indexed_container<ome::xml::model::Well, ome::compat::weak_ptr>::type::size_type index,
                                     const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);

        bool
        linkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);

        bool
        unlinkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);

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

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

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

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

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

        bool
        unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_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_ANNOTATION_H

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