bioformats  5.1.8
ExperimenterGroup.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2016 Open Microscopy Environment:
6  * - Massachusetts Institute of Technology
7  * - National Institutes of Health
8  * - University of Dundee
9  * - Board of Regents of the University of Wisconsin-Madison
10  * - Glencoe Software, Inc.
11  * %%
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  * this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright notice,
18  * this list of conditions and the following disclaimer in the documentation
19  * and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * The views and conclusions contained in the software and documentation are
34  * those of the authors and should not be interpreted as representing official
35  * policies, either expressed or implied, of any organization.
36  * #L%
37  */
38 
39 /*─────────────────────────────────────────────────────────────────────────────
40  *
41  * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42  *
43  *─────────────────────────────────────────────────────────────────────────────
44  */
45 
46 #ifndef OME_XML_MODEL_EXPERIMENTERGROUP_H
47 #define OME_XML_MODEL_EXPERIMENTERGROUP_H
48 
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54 
55 #include <ome/common/log.h>
56 
57 #include <ome/common/xml/dom/Document.h>
58 #include <ome/common/xml/dom/Element.h>
59 #include <ome/common/xml/dom/Node.h>
60 #include <ome/common/xml/dom/NodeList.h>
61 
62 #include <ome/xml/model/detail/OMEModelObject.h>
63 
64 namespace ome
65 {
66  namespace xml
67  {
68  namespace model
69  {
70 
71  // Forward declarations.
72  class Annotation;
73  class Dataset;
74  class Experimenter;
75  class Image;
76  class OMEModel;
77  class Project;
78 
83  {
84  private:
85  class Impl;
87  ome::compat::shared_ptr<Impl> impl;
88 
89  public:
92 
99 
101  virtual
103 
118  static ome::compat::shared_ptr< ExperimenterGroup>
119  create(const common::xml::dom::Element& element,
121 
122  // Documented in superclass.
123  const std::string&
124  elementName() const;
125 
126  // Documented in superclass.
127  bool
128  validElementName(const std::string& name) const;
129 
130 
131  // -- OMEModelObject API methods --
132 
134  virtual void
135  update(const common::xml::dom::Element& element,
137 
138  public:
139  // -- ExperimenterGroup API methods --
140 
142  bool
143  link (ome::compat::shared_ptr<Reference>& reference,
144  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
145 
151  ome::compat::shared_ptr<std::string>
152  getName ();
153 
159  const ome::compat::shared_ptr<std::string>
160  getName () const;
161 
167  void
168  setName (ome::compat::shared_ptr<std::string>& name);
169 
175  const std::string&
176  getID () const;
177 
183  void
184  setID (const std::string& id);
185 
191  ome::compat::shared_ptr<std::string>
192  getDescription ();
193 
199  const ome::compat::shared_ptr<std::string>
200  getDescription () const;
201 
207  void
208  setDescription (ome::compat::shared_ptr<std::string>& description);
209 
217 
224  getLinkedExperimenterList () const;
225 
233  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
235 
246  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
248  const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
249 
260  bool
261  linkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
262 
278  bool
279  unlinkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
280 
287  sizeOfLinkedLeaderList () const;
288 
295  getLinkedLeaderList () const;
296 
304  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
306 
317  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
319  const ome::compat::shared_ptr<ome::xml::model::Experimenter>& leader);
320 
331  bool
332  linkLeader (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& leader);
333 
349  bool
350  unlinkLeader (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& leader);
351 
359 
366  getLinkedAnnotationList () const;
367 
375  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
377 
388  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
390  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
391 
402  bool
403  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
404 
420  bool
421  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
422 
429  sizeOfLinkedImageList () const;
430 
437  getLinkedImageList () const;
438 
446  const ome::compat::weak_ptr<ome::xml::model::Image>&
448 
459  const ome::compat::weak_ptr<ome::xml::model::Image>&
461  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
462 
473  bool
474  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
475 
491  bool
492  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
493 
500  sizeOfLinkedProjectList () const;
501 
508  getLinkedProjectList () const;
509 
517  const ome::compat::weak_ptr<ome::xml::model::Project>&
519 
530  const ome::compat::weak_ptr<ome::xml::model::Project>&
532  const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
533 
544  bool
545  linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
546 
562  bool
563  unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
564 
571  sizeOfLinkedDatasetList () const;
572 
579  getLinkedDatasetList () const;
580 
588  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
590 
601  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
603  const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
604 
615  bool
616  linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
617 
633  bool
634  unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
635 
636 
639  asXMLElement (common::xml::dom::Document& document) const;
640 
641 
642  protected:
643  // Documented in base class.
646  common::xml::dom::Element& element) const;
647 
648  public:
649  // Documented in superclass.
650  const std::string&
651  getXMLNamespace() const;
652  };
653 
654  }
655  }
656 }
657 
658 #endif // OME_XML_MODEL_EXPERIMENTERGROUP_H
659 
660 /*
661  * Local Variables:
662  * mode:C++
663  * End:
664  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual ~ExperimenterGroup()
Destructor.
Definition: ExperimenterGroup.cpp:193
ExperimenterGroup model object.
Definition: ExperimenterGroup.h:82
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ExperimenterGroup.cpp:214
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedExperimenterList() const
Get the linked Experimenter list.
Definition: ExperimenterGroup.cpp:435
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ExperimenterGroup.cpp:913
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: ExperimenterGroup.cpp:310
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: ExperimenterGroup.cpp:731
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: ExperimenterGroup.cpp:708
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)
Set linked Experimenter.
Definition: ExperimenterGroup.cpp:447
bool unlinkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: ExperimenterGroup.cpp:471
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
Get linked Dataset.
Definition: ExperimenterGroup.cpp:737
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)
Set linked Image.
Definition: ExperimenterGroup.cpp:627
void setID(const std::string &id)
Set the ID property.
Definition: ExperimenterGroup.cpp:401
static ome::compat::shared_ptr< ExperimenterGroup > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a ExperimenterGroup model object from DOM element.
Definition: ExperimenterGroup.cpp:198
const std::string & getID() const
Get the ID property.
Definition: ExperimenterGroup.cpp:394
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & getLinkedLeader(OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index) const
Get linked Leader.
Definition: ExperimenterGroup.cpp:501
bool linkLeader(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
Link Leader.
Definition: ExperimenterGroup.cpp:517
const std::string & elementName() const
Get the element name of this model object.
Definition: ExperimenterGroup.cpp:207
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: ExperimenterGroup.cpp:695
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: ExperimenterGroup.cpp:555
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
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
Get linked Experimenter.
Definition: ExperimenterGroup.cpp:441
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: ExperimenterGroup.cpp:637
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: ExperimenterGroup.cpp:725
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)
Set linked Dataset.
Definition: ExperimenterGroup.cpp:743
ExperimenterGroup()
Default constructor.
Definition: ExperimenterGroup.cpp:174
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: ExperimenterGroup.cpp:577
Private implementation details of ExperimenterGroup model object.
Definition: ExperimenterGroup.cpp:78
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterList() const
Get size of linked Experimenter list.
Definition: ExperimenterGroup.cpp:429
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: ExperimenterGroup.cpp:223
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: ExperimenterGroup.cpp:387
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: ExperimenterGroup.cpp:766
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
bool unlinkLeader(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
Unlink Leader.
Definition: ExperimenterGroup.cpp:531
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: ExperimenterGroup.cpp:422
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: ExperimenterGroup.cpp:408
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
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)
Set linked Project.
Definition: ExperimenterGroup.cpp:685
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: ExperimenterGroup.cpp:673
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & setLinkedLeader(OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
Set linked Leader.
Definition: ExperimenterGroup.cpp:507
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ExperimenterGroup.h:85
bool linkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: ExperimenterGroup.cpp:457
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: ExperimenterGroup.cpp:790
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
Get linked Project.
Definition: ExperimenterGroup.cpp:679
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: ExperimenterGroup.cpp:609
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: ExperimenterGroup.cpp:549
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: ExperimenterGroup.cpp:783
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: ExperimenterGroup.cpp:650
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: ExperimenterGroup.cpp:667
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: ExperimenterGroup.cpp:615
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLeaderList() const
Get size of linked Leader list.
Definition: ExperimenterGroup.cpp:489
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedLeaderList() const
Get the linked Leader list.
Definition: ExperimenterGroup.cpp:495
Boost.Log compatibility.
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
Get linked Image.
Definition: ExperimenterGroup.cpp:621
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)
Set linked Annotation.
Definition: ExperimenterGroup.cpp:567
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
Get linked Annotation.
Definition: ExperimenterGroup.cpp:561
Xerces-C modern C++ wrapper.
Definition: Base.h:53
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: ExperimenterGroup.cpp:591
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: ExperimenterGroup.cpp:753
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: ExperimenterGroup.cpp:373