ome-xml  5.6.0
Well.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_WELL_H
47 #define OME_XML_MODEL_WELL_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/Plate.h>
64 #include <ome/xml/model/Reagent.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66 #include <ome/xml/model/primitives/Color.h>
67 #include <ome/xml/model/primitives/NonNegativeInteger.h>
68 
69 namespace ome
70 {
71  namespace xml
72  {
73  namespace model
74  {
75 
76  // Forward declarations.
77  class Annotation;
78  class OMEModel;
79  class WellSample;
80 
85  {
86  private:
87  class Impl;
89  std::shared_ptr<Impl> impl;
90 
91  public:
93  Well();
94 
100  Well (const Well& copy);
101 
103  virtual
104  ~Well ();
105 
120  static std::shared_ptr<Well>
121  create(const common::xml::dom::Element& element,
123 
124  // Documented in superclass.
125  const std::string&
126  elementName() const;
127 
128  // Documented in superclass.
129  bool
130  validElementName(const std::string& name) const;
131 
133  Well&
134  operator= (const Well&) = delete;
136 
137  // -- OMEModelObject API methods --
138 
140  virtual void
141  update(const common::xml::dom::Element& element,
143 
144  public:
145  // -- Well API methods --
146 
148  bool
149  link (std::shared_ptr<Reference>& reference,
150  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
151 
157  std::shared_ptr<std::string>
159 
165  const std::shared_ptr<std::string>
166  getExternalIdentifier () const;
167 
173  void
174  setExternalIdentifier (std::shared_ptr<std::string>& externalIdentifier);
175 
182  getColumn () const;
183 
189  void
191 
197  std::shared_ptr<std::string>
199 
205  const std::shared_ptr<std::string>
206  getExternalDescription () const;
207 
213  void
214  setExternalDescription (std::shared_ptr<std::string>& externalDescription);
215 
221  std::shared_ptr<ome::xml::model::primitives::Color>
222  getColor ();
223 
229  const std::shared_ptr<ome::xml::model::primitives::Color>
230  getColor () const;
231 
237  void
238  setColor (std::shared_ptr<ome::xml::model::primitives::Color>& color);
239 
245  std::shared_ptr<std::string>
246  getType ();
247 
253  const std::shared_ptr<std::string>
254  getType () const;
255 
261  void
262  setType (std::shared_ptr<std::string>& type);
263 
269  const std::string&
270  getID () const;
271 
277  void
278  setID (const std::string& id);
279 
286  getRow () const;
287 
293  void
295 
301  std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type
302  sizeOfWellSampleList () const;
303 
310  std::vector<std::shared_ptr<ome::xml::model::WellSample>>&
312 
319  const std::vector<std::shared_ptr<ome::xml::model::WellSample>>&
320  getWellSampleList () const;
321 
329  std::shared_ptr<ome::xml::model::WellSample>&
330  getWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index);
331 
339  const std::shared_ptr<ome::xml::model::WellSample>&
340  getWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index) const;
341 
349  void
350  setWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index,
351  std::shared_ptr<ome::xml::model::WellSample>& wellSample);
352 
361  void
362  addWellSample (std::shared_ptr<ome::xml::model::WellSample>& wellSample);
363 
373  void
374  removeWellSample (std::shared_ptr<ome::xml::model::WellSample>& wellSample);
375 
382  std::weak_ptr<ome::xml::model::Reagent>
383  getLinkedReagent ();
384 
391  const std::weak_ptr<ome::xml::model::Reagent>
392  getLinkedReagent () const;
393 
399  void
400  linkReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
401 
411  void
412  unlinkReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
413 
421 
428  getLinkedAnnotationList () const;
429 
437  const std::weak_ptr<ome::xml::model::Annotation>&
439 
450  const std::weak_ptr<ome::xml::model::Annotation>&
452  const std::shared_ptr<ome::xml::model::Annotation>& annotation);
453 
464  bool
465  linkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
466 
482  bool
483  unlinkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
484 
490  std::weak_ptr<ome::xml::model::Plate>
491  getPlate ();
492 
498  const std::weak_ptr<ome::xml::model::Plate>
499  getPlate () const;
500 
506  void
507  setPlate (std::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
508 
509  protected:
510  // Documented in base class.
511  virtual void
513  common::xml::dom::Element& element) const;
514 
515  public:
516  // Documented in superclass.
517  const std::string&
518  getXMLNamespace() const;
519  };
520 
521  }
522  }
523 }
524 
525 #endif // OME_XML_MODEL_WELL_H
526 
527 /*
528  * Local Variables:
529  * mode:C++
530  * End:
531  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
const std::string & getID() const
Get the ID property.
Definition: Well.cpp:491
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Well.cpp:612
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
const std::string & elementName() const
Get the element name of this model object.
Definition: Well.cpp:226
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void setRow(const ome::xml::model::primitives::NonNegativeInteger &row)
Set the Row property.
Definition: Well.cpp:512
static std::shared_ptr< Well > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Well model object from DOM element.
Definition: Well.cpp:217
void setWellSample(std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index, std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Set WellSample.
Definition: Well.cpp:549
void setType(std::shared_ptr< std::string > &type)
Set the Type property.
Definition: Well.cpp:484
std::vector< std::shared_ptr< ome::xml::model::WellSample > >::size_type sizeOfWellSampleList() const
Get size of linked WellSample list.
Definition: Well.cpp:519
Well model object.
Definition: Well.h:84
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: Well.cpp:686
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Well.cpp:811
virtual ~Well()
Destructor.
Definition: Well.cpp:212
std::vector< std::shared_ptr< ome::xml::model::WellSample > > & getWellSampleList()
Get the WellSample list.
Definition: Well.cpp:525
const ome::xml::model::primitives::NonNegativeInteger & getColumn() const
Get the Column property.
Definition: Well.cpp:414
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
void setExternalIdentifier(std::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Well.cpp:407
std::weak_ptr< ome::xml::model::Reagent > getLinkedReagent()
Get linked Reagent.
Definition: Well.cpp:577
void unlinkReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Unlink Reagent.
Definition: Well.cpp:596
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: Well.cpp:233
void setID(const std::string &id)
Set the ID property.
Definition: Well.cpp:498
std::shared_ptr< ome::xml::model::WellSample > & getWellSample(std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index)
Get WellSample.
Definition: Well.cpp:537
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Well.cpp:648
std::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Well.cpp:393
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Well.cpp:618
void removeWellSample(std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Remove WellSample.
Definition: Well.cpp:566
void setColumn(const ome::xml::model::primitives::NonNegativeInteger &column)
Set the Column property.
Definition: Well.cpp:421
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Well.cpp:624
std::shared_ptr< std::string > getType()
Get the Type property.
Definition: Well.cpp:470
void linkReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Link Reagent.
Definition: Well.cpp:590
std::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Well.cpp:449
Private implementation details of Well model object.
Definition: Well.cpp:80
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Well.cpp:606
void setColor(std::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Well.cpp:463
std::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: Well.cpp:666
void setExternalDescription(std::shared_ptr< std::string > &externalDescription)
Set the ExternalDescription property.
Definition: Well.cpp:442
void addWellSample(std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Add WellSample.
Definition: Well.cpp:558
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Well.cpp:634
std::shared_ptr< std::string > getExternalDescription()
Get the ExternalDescription property.
Definition: Well.cpp:428
void setPlate(std::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: Well.cpp:680
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: Well.cpp:351
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: Well.cpp:239
Well()
Default constructor.
Definition: Well.cpp:193
const ome::xml::model::primitives::NonNegativeInteger & getRow() const
Get the Row property.
Definition: Well.cpp:505
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:118
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Well.h:87