bioformats  5.1.6
Plate.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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_PLATE_H
47 #define OME_XML_MODEL_PLATE_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 #include <ome/xml/model/enums/NamingConvention.h>
64 #include <ome/xml/model/primitives/NonNegativeInteger.h>
65 #include <ome/xml/model/primitives/PositiveInteger.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class Annotation;
76  class OMEModel;
77  class PlateAcquisition;
78  class Screen;
79  class Well;
80 
85  {
86  private:
87  class Impl;
89  ome::compat::shared_ptr<Impl> impl;
90 
91  public:
93  Plate();
94 
100  Plate (const Plate& copy);
101 
103  virtual
104  ~Plate ();
105 
120  static ome::compat::shared_ptr< Plate>
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 
132 
133  // -- OMEModelObject API methods --
134 
136  virtual void
137  update(const common::xml::dom::Element& element,
139 
140  public:
141  // -- Plate API methods --
142 
144  bool
145  link (ome::compat::shared_ptr<Reference>& reference,
146  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
147 
153  ome::compat::shared_ptr<std::string>
154  getStatus ();
155 
161  const ome::compat::shared_ptr<std::string>
162  getStatus () const;
163 
169  void
170  setStatus (ome::compat::shared_ptr<std::string>& status);
171 
177  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
178  getRows ();
179 
185  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
186  getRows () const;
187 
193  void
194  setRows (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& rows);
195 
201  ome::compat::shared_ptr<std::string>
203 
209  const ome::compat::shared_ptr<std::string>
210  getExternalIdentifier () const;
211 
217  void
218  setExternalIdentifier (ome::compat::shared_ptr<std::string>& externalIdentifier);
219 
225  ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
227 
233  const ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
234  getRowNamingConvention () const;
235 
241  void
242  setRowNamingConvention (ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>& rowNamingConvention);
243 
249  ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
251 
257  const ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
258  getColumnNamingConvention () const;
259 
265  void
266  setColumnNamingConvention (ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>& columnNamingConvention);
267 
273  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
274  getFieldIndex ();
275 
281  const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
282  getFieldIndex () const;
283 
289  void
290  setFieldIndex (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& fieldIndex);
291 
297  ome::compat::shared_ptr<double>
298  getWellOriginY ();
299 
305  const ome::compat::shared_ptr<double>
306  getWellOriginY () const;
307 
313  void
314  setWellOriginY (ome::compat::shared_ptr<double>& wellOriginY);
315 
321  ome::compat::shared_ptr<double>
322  getWellOriginX ();
323 
329  const ome::compat::shared_ptr<double>
330  getWellOriginX () const;
331 
337  void
338  setWellOriginX (ome::compat::shared_ptr<double>& wellOriginX);
339 
345  const std::string&
346  getID () const;
347 
353  void
354  setID (const std::string& id);
355 
361  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
362  getColumns ();
363 
369  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
370  getColumns () const;
371 
377  void
378  setColumns (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& columns);
379 
385  ome::compat::shared_ptr<std::string>
386  getName ();
387 
393  const ome::compat::shared_ptr<std::string>
394  getName () const;
395 
401  void
402  setName (ome::compat::shared_ptr<std::string>& name);
403 
409  ome::compat::shared_ptr<std::string>
410  getDescription ();
411 
417  const ome::compat::shared_ptr<std::string>
418  getDescription () const;
419 
425  void
426  setDescription (ome::compat::shared_ptr<std::string>& description);
427 
433  std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type
434  sizeOfWellList () const;
435 
442  std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >&
443  getWellList ();
444 
451  const std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >&
452  getWellList () const;
453 
461  ome::compat::shared_ptr<ome::xml::model::Well>&
462  getWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index);
463 
471  const ome::compat::shared_ptr<ome::xml::model::Well>&
472  getWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index) const;
473 
481  void
482  setWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index,
483  ome::compat::shared_ptr<ome::xml::model::Well>& well);
484 
493  void
494  addWell (ome::compat::shared_ptr<ome::xml::model::Well>& well);
495 
505  void
506  removeWell (ome::compat::shared_ptr<ome::xml::model::Well>& well);
507 
515 
522  getLinkedAnnotationList () const;
523 
531  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
533 
544  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
546  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
547 
558  bool
559  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
560 
576  bool
577  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
578 
584  std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type
586 
593  std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >&
595 
602  const std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >&
603  getPlateAcquisitionList () const;
604 
612  ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>&
613  getPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index);
614 
622  const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>&
623  getPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index) const;
624 
632  void
633  setPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index,
634  ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
635 
644  void
645  addPlateAcquisition (ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
646 
656  void
657  removePlateAcquisition (ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
658 
665  sizeOfLinkedScreenList () const;
666 
673  getLinkedScreenList () const;
674 
682  const ome::compat::weak_ptr<ome::xml::model::Screen>&
684 
695  const ome::compat::weak_ptr<ome::xml::model::Screen>&
697  const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
698 
709  bool
710  linkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
711 
727  bool
728  unlinkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
729 
730 
733  asXMLElement (common::xml::dom::Document& document) const;
734 
735 
736  protected:
737  // Documented in base class.
740  common::xml::dom::Element& element) const;
741 
742  public:
743  // Documented in superclass.
744  const std::string&
745  getXMLNamespace() const;
746  };
747 
748  }
749  }
750 }
751 
752 #endif // OME_XML_MODEL_PLATE_H
753 
754 /*
755  * Local Variables:
756  * mode:C++
757  * End:
758  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setWell(std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Well > &well)
Set Well.
Definition: Plate.cpp:746
bool linkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Plate.cpp:920
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type sizeOfWellList() const
Get size of linked Well list.
Definition: Plate.cpp:716
virtual ~Plate()
Destructor.
Definition: Plate.cpp:246
Plate model object.
Definition: Plate.h:84
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: Plate.cpp:957
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plate.cpp:816
const std::string & getID() const
Get the ID property.
Definition: Plate.cpp:639
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: Plate.cpp:276
const std::string & elementName() const
Get the element name of this model object.
Definition: Plate.cpp:260
void removeWell(ome::compat::shared_ptr< ome::xml::model::Well > &well)
Remove Well.
Definition: Plate.cpp:763
void setID(const std::string &id)
Set the ID property.
Definition: Plate.cpp:646
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Plate.cpp:898
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Plate.cpp:950
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
Get linked Screen.
Definition: Plate.cpp:904
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type sizeOfPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: Plate.cpp:834
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
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
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)
Set linked Screen.
Definition: Plate.cpp:910
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plate.cpp:780
void addPlateAcquisition(ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Add PlateAcquisition.
Definition: Plate.cpp:873
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plate.cpp:802
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getColumns()
Get the Columns property.
Definition: Plate.cpp:653
void setRowNamingConvention(ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &rowNamingConvention)
Set the RowNamingConvention property.
Definition: Plate.cpp:548
void setRows(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &rows)
Set the Rows property.
Definition: Plate.cpp:506
ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > getRowNamingConvention()
Get the RowNamingConvention property.
Definition: Plate.cpp:534
Plate()
Default constructor.
Definition: Plate.cpp:227
void setWellOriginY(ome::compat::shared_ptr< double > &wellOriginY)
Set the WellOriginY property.
Definition: Plate.cpp:611
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Plate.cpp:695
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Plate.cpp:709
void setExternalIdentifier(ome::compat::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Plate.cpp:527
void setStatus(ome::compat::shared_ptr< std::string > &status)
Set the Status property.
Definition: Plate.cpp:485
ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & getPlateAcquisition(std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index)
Get PlateAcquisition.
Definition: Plate.cpp:852
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type sizeOfLinkedScreenList() const
Get size of linked Screen list.
Definition: Plate.cpp:892
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< double > getWellOriginY()
Get the WellOriginY property.
Definition: Plate.cpp:597
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & getWellList()
Get the Well list.
Definition: Plate.cpp:722
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Plate.cpp:674
void addWell(ome::compat::shared_ptr< ome::xml::model::Well > &well)
Add Well.
Definition: Plate.cpp:755
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getRows()
Get the Rows property.
Definition: Plate.cpp:492
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: Plate.cpp:440
void setColumns(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &columns)
Set the Columns property.
Definition: Plate.cpp:667
void setColumnNamingConvention(ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &columnNamingConvention)
Set the ColumnNamingConvention property.
Definition: Plate.cpp:569
void setFieldIndex(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fieldIndex)
Set the FieldIndex property.
Definition: Plate.cpp:590
ome::compat::shared_ptr< std::string > getStatus()
Get the Status property.
Definition: Plate.cpp:471
ome::compat::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Plate.cpp:513
void removePlateAcquisition(ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Remove PlateAcquisition.
Definition: Plate.cpp:881
ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > getColumnNamingConvention()
Get the ColumnNamingConvention property.
Definition: Plate.cpp:555
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFieldIndex()
Get the FieldIndex property.
Definition: Plate.cpp:576
ome::compat::shared_ptr< double > getWellOriginX()
Get the WellOriginX property.
Definition: Plate.cpp:618
void setWellOriginX(ome::compat::shared_ptr< double > &wellOriginX)
Set the WellOriginX property.
Definition: Plate.cpp:632
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Plate.cpp:267
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Plate.cpp:688
bool unlinkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Plate.cpp:933
void setPlateAcquisition(std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index, ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Set PlateAcquisition.
Definition: Plate.cpp:864
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & getPlateAcquisitionList()
Get the PlateAcquisition list.
Definition: Plate.cpp:840
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: Plate.cpp:792
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plate.cpp:1172
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: Plate.cpp:786
Boost.Log compatibility.
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Plate.h:87
Private implementation details of Plate model object.
Definition: Plate.cpp:82
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plate.cpp:774
Xerces-C modern C++ wrapper.
Definition: Base.h:53
ome::compat::shared_ptr< ome::xml::model::Well > & getWell(std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index)
Get Well.
Definition: Plate.cpp:734
static ome::compat::shared_ptr< Plate > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Plate model object from DOM element.
Definition: Plate.cpp:251