StructuredAnnotations.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_STRUCTUREDANNOTATIONS_H
#define OME_XML_MODEL_STRUCTUREDANNOTATIONS_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/detail/OMEModelObject.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      // Forward declarations.
      class BooleanAnnotation;
      class CommentAnnotation;
      class DoubleAnnotation;
      class FileAnnotation;
      class ListAnnotation;
      class LongAnnotation;
      class MapAnnotation;
      class OMEModel;
      class TagAnnotation;
      class TermAnnotation;
      class TimestampAnnotation;
      class XMLAnnotation;

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

      public:
        StructuredAnnotations();

        StructuredAnnotations (const StructuredAnnotations& copy);

        virtual
        ~StructuredAnnotations ();

        static std::shared_ptr<StructuredAnnotations>
        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:
        StructuredAnnotations&
        operator= (const StructuredAnnotations&);

      public:
        // -- OMEModelObject API methods --

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

      public:
        // -- StructuredAnnotations API methods --

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

        std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>::size_type
        sizeOfXMLAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>&
        getXMLAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>&
        getXMLAnnotationList () const;

        std::shared_ptr<ome::xml::model::XMLAnnotation>&
        getXMLAnnotation (std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::XMLAnnotation>&
        getXMLAnnotation (std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>::size_type index) const;

        void
        setXMLAnnotation (std::vector<std::shared_ptr<ome::xml::model::XMLAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::XMLAnnotation>& xmlAnnotation);

        void
        addXMLAnnotation (std::shared_ptr<ome::xml::model::XMLAnnotation>& xmlAnnotation);

        void
        removeXMLAnnotation (std::shared_ptr<ome::xml::model::XMLAnnotation>& xmlAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>::size_type
        sizeOfFileAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>&
        getFileAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>&
        getFileAnnotationList () const;

        std::shared_ptr<ome::xml::model::FileAnnotation>&
        getFileAnnotation (std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::FileAnnotation>&
        getFileAnnotation (std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>::size_type index) const;

        void
        setFileAnnotation (std::vector<std::shared_ptr<ome::xml::model::FileAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::FileAnnotation>& fileAnnotation);

        void
        addFileAnnotation (std::shared_ptr<ome::xml::model::FileAnnotation>& fileAnnotation);

        void
        removeFileAnnotation (std::shared_ptr<ome::xml::model::FileAnnotation>& fileAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>::size_type
        sizeOfListAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>&
        getListAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>&
        getListAnnotationList () const;

        std::shared_ptr<ome::xml::model::ListAnnotation>&
        getListAnnotation (std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::ListAnnotation>&
        getListAnnotation (std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>::size_type index) const;

        void
        setListAnnotation (std::vector<std::shared_ptr<ome::xml::model::ListAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::ListAnnotation>& listAnnotation);

        void
        addListAnnotation (std::shared_ptr<ome::xml::model::ListAnnotation>& listAnnotation);

        void
        removeListAnnotation (std::shared_ptr<ome::xml::model::ListAnnotation>& listAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>::size_type
        sizeOfLongAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>&
        getLongAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>&
        getLongAnnotationList () const;

        std::shared_ptr<ome::xml::model::LongAnnotation>&
        getLongAnnotation (std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::LongAnnotation>&
        getLongAnnotation (std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>::size_type index) const;

        void
        setLongAnnotation (std::vector<std::shared_ptr<ome::xml::model::LongAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::LongAnnotation>& longAnnotation);

        void
        addLongAnnotation (std::shared_ptr<ome::xml::model::LongAnnotation>& longAnnotation);

        void
        removeLongAnnotation (std::shared_ptr<ome::xml::model::LongAnnotation>& longAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>::size_type
        sizeOfDoubleAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>&
        getDoubleAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>&
        getDoubleAnnotationList () const;

        std::shared_ptr<ome::xml::model::DoubleAnnotation>&
        getDoubleAnnotation (std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::DoubleAnnotation>&
        getDoubleAnnotation (std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>::size_type index) const;

        void
        setDoubleAnnotation (std::vector<std::shared_ptr<ome::xml::model::DoubleAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::DoubleAnnotation>& doubleAnnotation);

        void
        addDoubleAnnotation (std::shared_ptr<ome::xml::model::DoubleAnnotation>& doubleAnnotation);

        void
        removeDoubleAnnotation (std::shared_ptr<ome::xml::model::DoubleAnnotation>& doubleAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>::size_type
        sizeOfCommentAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>&
        getCommentAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>&
        getCommentAnnotationList () const;

        std::shared_ptr<ome::xml::model::CommentAnnotation>&
        getCommentAnnotation (std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::CommentAnnotation>&
        getCommentAnnotation (std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>::size_type index) const;

        void
        setCommentAnnotation (std::vector<std::shared_ptr<ome::xml::model::CommentAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::CommentAnnotation>& commentAnnotation);

        void
        addCommentAnnotation (std::shared_ptr<ome::xml::model::CommentAnnotation>& commentAnnotation);

        void
        removeCommentAnnotation (std::shared_ptr<ome::xml::model::CommentAnnotation>& commentAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>::size_type
        sizeOfBooleanAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>&
        getBooleanAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>&
        getBooleanAnnotationList () const;

        std::shared_ptr<ome::xml::model::BooleanAnnotation>&
        getBooleanAnnotation (std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::BooleanAnnotation>&
        getBooleanAnnotation (std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>::size_type index) const;

        void
        setBooleanAnnotation (std::vector<std::shared_ptr<ome::xml::model::BooleanAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::BooleanAnnotation>& booleanAnnotation);

        void
        addBooleanAnnotation (std::shared_ptr<ome::xml::model::BooleanAnnotation>& booleanAnnotation);

        void
        removeBooleanAnnotation (std::shared_ptr<ome::xml::model::BooleanAnnotation>& booleanAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>::size_type
        sizeOfTimestampAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>&
        getTimestampAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>&
        getTimestampAnnotationList () const;

        std::shared_ptr<ome::xml::model::TimestampAnnotation>&
        getTimestampAnnotation (std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::TimestampAnnotation>&
        getTimestampAnnotation (std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>::size_type index) const;

        void
        setTimestampAnnotation (std::vector<std::shared_ptr<ome::xml::model::TimestampAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::TimestampAnnotation>& timestampAnnotation);

        void
        addTimestampAnnotation (std::shared_ptr<ome::xml::model::TimestampAnnotation>& timestampAnnotation);

        void
        removeTimestampAnnotation (std::shared_ptr<ome::xml::model::TimestampAnnotation>& timestampAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>::size_type
        sizeOfTagAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>&
        getTagAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>&
        getTagAnnotationList () const;

        std::shared_ptr<ome::xml::model::TagAnnotation>&
        getTagAnnotation (std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::TagAnnotation>&
        getTagAnnotation (std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>::size_type index) const;

        void
        setTagAnnotation (std::vector<std::shared_ptr<ome::xml::model::TagAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::TagAnnotation>& tagAnnotation);

        void
        addTagAnnotation (std::shared_ptr<ome::xml::model::TagAnnotation>& tagAnnotation);

        void
        removeTagAnnotation (std::shared_ptr<ome::xml::model::TagAnnotation>& tagAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>::size_type
        sizeOfTermAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>&
        getTermAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>&
        getTermAnnotationList () const;

        std::shared_ptr<ome::xml::model::TermAnnotation>&
        getTermAnnotation (std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::TermAnnotation>&
        getTermAnnotation (std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>::size_type index) const;

        void
        setTermAnnotation (std::vector<std::shared_ptr<ome::xml::model::TermAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::TermAnnotation>& termAnnotation);

        void
        addTermAnnotation (std::shared_ptr<ome::xml::model::TermAnnotation>& termAnnotation);

        void
        removeTermAnnotation (std::shared_ptr<ome::xml::model::TermAnnotation>& termAnnotation);

        std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>::size_type
        sizeOfMapAnnotationList () const;

        std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>&
        getMapAnnotationList ();

        const std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>&
        getMapAnnotationList () const;

        std::shared_ptr<ome::xml::model::MapAnnotation>&
        getMapAnnotation (std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>::size_type index);

        const std::shared_ptr<ome::xml::model::MapAnnotation>&
        getMapAnnotation (std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>::size_type index) const;

        void
        setMapAnnotation (std::vector<std::shared_ptr<ome::xml::model::MapAnnotation>>::size_type index,
                               std::shared_ptr<ome::xml::model::MapAnnotation>& mapAnnotation);

        void
        addMapAnnotation (std::shared_ptr<ome::xml::model::MapAnnotation>& mapAnnotation);

        void
        removeMapAnnotation (std::shared_ptr<ome::xml::model::MapAnnotation>& mapAnnotation);

      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_STRUCTUREDANNOTATIONS_H

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