ome-xml  5.6.0
Leader.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_LEADER_H
47 #define OME_XML_MODEL_LEADER_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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/Reference.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class ExperimenterGroup;
74  class OMEModel;
75 
79  class Leader : public Reference
80  {
81  private:
82  class Impl;
84  std::shared_ptr<Impl> impl;
85 
86  public:
88  Leader();
89 
95  Leader (const Leader& copy);
96 
98  virtual
99  ~Leader ();
100 
115  static std::shared_ptr<Leader>
116  create(const common::xml::dom::Element& element,
118 
119  // Documented in superclass.
120  const std::string&
121  elementName() const;
122 
123  // Documented in superclass.
124  bool
125  validElementName(const std::string& name) const;
126 
128  Leader&
129  operator= (const Leader&) = delete;
131 
132  // -- OMEModelObject API methods --
133 
135  virtual void
136  update(const common::xml::dom::Element& element,
138 
139  public:
140  // -- Leader API methods --
141 
143  bool
144  link (std::shared_ptr<Reference>& reference,
145  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
146 
152  const std::string&
153  getID () const;
154 
160  void
161  setID (const std::string& id);
162 
170 
178 
186  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
188 
199  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
201  const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
202 
213  bool
214  linkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
215 
231  bool
232  unlinkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
233 
234  protected:
235  // Documented in base class.
236  virtual void
238  common::xml::dom::Element& element) const;
239 
240  public:
241  // Documented in superclass.
242  const std::string&
243  getXMLNamespace() const;
244  };
245 
246  }
247  }
248 }
249 
250 #endif // OME_XML_MODEL_LEADER_H
251 
252 /*
253  * Local Variables:
254  * mode:C++
255  * End:
256  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
virtual void asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Leader.cpp:281
virtual SKIP void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Leader.cpp:167
Leader()
Default constructor.
Definition: Leader.cpp:121
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Leader.cpp:195
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 > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
virtual ~Leader()
Destructor.
Definition: Leader.cpp:140
bool linkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Leader.cpp:252
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: Leader.cpp:224
Private implementation details of Leader model object.
Definition: Leader.cpp:71
Leader model object.
Definition: Leader.h:79
const std::string & elementName() const
Get the element name of this model object.
Definition: Leader.cpp:154
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
Open Microscopy Environment C++ implementation.
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Leader.cpp:161
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type getLinkedExperimenterGroupList() const
Get the linked ExperimenterGroup list.
Definition: Leader.cpp:230
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Leader.h:82
const std::string & getID() const
Get the ID property.
Definition: Leader.cpp:210
void setID(const std::string &id)
Set the ID property.
Definition: Leader.cpp:217
Reference model object.
Definition: Reference.h:78
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Set linked ExperimenterGroup.
Definition: Leader.cpp:242
bool unlinkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Leader.cpp:265
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Leader.cpp:305
static std::shared_ptr< Leader > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Leader model object from DOM element.
Definition: Leader.cpp:145
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index) const
Get linked ExperimenterGroup.
Definition: Leader.cpp:236