bioformats  5.1.0
Screen.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_SCREEN_H
47 #define OME_XML_MODEL_SCREEN_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 OMEModel;
74  class Plate;
75  class Reagent;
76 
81  {
82  private:
84  ome::compat::shared_ptr<std::string> name;
86  ome::compat::shared_ptr<std::string> protocolDescription;
88  ome::compat::shared_ptr<std::string> protocolIdentifier;
90  ome::compat::shared_ptr<std::string> reagentSetDescription;
92  ome::compat::shared_ptr<std::string> type;
94  std::string id;
96  ome::compat::shared_ptr<std::string> reagentSetIdentifier;
98  ome::compat::shared_ptr<std::string> description;
100  std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> > reagents;
105 
106  public:
108  Screen ();
109 
115  Screen (const Screen& copy);
116 
118  virtual
119  ~Screen ();
120 
121 
122 
137  static ome::compat::shared_ptr< Screen>
138  create(const common::xml::dom::Element& element,
140 
141  // Documented in superclass.
142  const std::string&
143  elementName() const;
144 
145  // Documented in superclass.
146  bool
147  validElementName(const std::string& name) const;
148 
149 
150  // -- OMEModelObject API methods --
151 
153  virtual void
154  update(const common::xml::dom::Element& element,
156 
157  public:
158  // -- Screen API methods --
159 
161  bool
162  link (ome::compat::shared_ptr<Reference>& reference,
163  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
164 
170  ome::compat::shared_ptr<std::string>
171  getName ();
172 
178  const ome::compat::shared_ptr<std::string>
179  getName () const;
180 
186  void
187  setName (ome::compat::shared_ptr<std::string>& name);
188 
194  ome::compat::shared_ptr<std::string>
196 
202  const ome::compat::shared_ptr<std::string>
203  getProtocolDescription () const;
204 
210  void
211  setProtocolDescription (ome::compat::shared_ptr<std::string>& protocolDescription);
212 
218  ome::compat::shared_ptr<std::string>
220 
226  const ome::compat::shared_ptr<std::string>
227  getProtocolIdentifier () const;
228 
234  void
235  setProtocolIdentifier (ome::compat::shared_ptr<std::string>& protocolIdentifier);
236 
242  ome::compat::shared_ptr<std::string>
244 
250  const ome::compat::shared_ptr<std::string>
251  getReagentSetDescription () const;
252 
258  void
259  setReagentSetDescription (ome::compat::shared_ptr<std::string>& reagentSetDescription);
260 
266  ome::compat::shared_ptr<std::string>
267  getType ();
268 
274  const ome::compat::shared_ptr<std::string>
275  getType () const;
276 
282  void
283  setType (ome::compat::shared_ptr<std::string>& type);
284 
290  const std::string&
291  getID () const;
292 
298  void
299  setID (const std::string& id);
300 
306  ome::compat::shared_ptr<std::string>
308 
314  const ome::compat::shared_ptr<std::string>
315  getReagentSetIdentifier () const;
316 
322  void
323  setReagentSetIdentifier (ome::compat::shared_ptr<std::string>& reagentSetIdentifier);
324 
330  ome::compat::shared_ptr<std::string>
331  getDescription ();
332 
338  const ome::compat::shared_ptr<std::string>
339  getDescription () const;
340 
346  void
347  setDescription (ome::compat::shared_ptr<std::string>& description);
348 
354  std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type
355  sizeOfReagentList () const;
356 
363  std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >&
364  getReagentList ();
365 
372  const std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >&
373  getReagentList () const;
374 
382  ome::compat::shared_ptr<ome::xml::model::Reagent>&
383  getReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index);
384 
392  const ome::compat::shared_ptr<ome::xml::model::Reagent>&
393  getReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index) const;
394 
402  void
403  setReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index,
404  ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
405 
414  void
415  addReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
416 
426  void
427  removeReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
428 
435  sizeOfLinkedPlateList () const;
436 
443  getLinkedPlateList () const;
444 
452  const ome::compat::weak_ptr<ome::xml::model::Plate>&
454 
465  const ome::compat::weak_ptr<ome::xml::model::Plate>&
467  const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
468 
479  bool
480  linkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
481 
497  bool
498  unlinkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
499 
507 
514  getLinkedAnnotationList () const;
515 
523  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
525 
536  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
538  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
539 
550  bool
551  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
552 
568  bool
569  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
570 
571 
574  asXMLElement (common::xml::dom::Document& document) const;
575 
576 
577  protected:
578  // Documented in base class.
581  common::xml::dom::Element& element) const;
582 
583  public:
584  // Documented in superclass.
585  const std::string&
586  getXMLNamespace() const;
587  };
588 
589  }
590  }
591 }
592 
593 #endif // OME_XML_MODEL_SCREEN_H
594 
595 /*
596  * Local Variables:
597  * mode:C++
598  * End:
599  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & elementName() const
Get the element name of this model object.
Definition: Screen.cpp:184
ome::compat::shared_ptr< std::string > type
Type property.
Definition: Screen.h:92
const std::string & getID() const
Get the ID property.
Definition: Screen.cpp:484
std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > > & getReagentList()
Get the Reagent list.
Definition: Screen.cpp:546
const ome::compat::weak_ptr< ome::xml::model::Plate > & getLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index) const
Get linked Plate.
Definition: Screen.cpp:610
ome::compat::shared_ptr< std::string > getType()
Get the Type property.
Definition: Screen.cpp:463
ome::compat::shared_ptr< ome::xml::model::Reagent > & getReagent(std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > >::size_type index)
Get Reagent.
Definition: Screen.cpp:558
const ome::compat::weak_ptr< ome::xml::model::Plate > & setLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Set linked Plate.
Definition: Screen.cpp:616
DOM Document wrapper.
Definition: Document.h:80
DOM Element wrapper.
Definition: Element.h:66
ome::compat::shared_ptr< std::string > getReagentSetDescription()
Get the ReagentSetDescription property.
Definition: Screen.cpp:442
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
Screen()
Default constructor.
Definition: Screen.cpp:131
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
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Screen.cpp:533
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: Screen.cpp:200
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: Screen.cpp:725
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Screen.cpp:686
ome::compat::shared_ptr< std::string > reagentSetDescription
ReagentSetDescription property.
Definition: Screen.h:90
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Screen.cpp:604
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Screen.cpp:393
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: Screen.cpp:332
void addReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Add Reagent.
Definition: Screen.cpp:579
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type plateLinks
PlateRef reference (occurs more than once)
Definition: Screen.h:102
Screen model object.
Definition: Screen.h:80
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Screen.cpp:896
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
static ome::compat::shared_ptr< Screen > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Screen model object from DOM element.
Definition: Screen.cpp:175
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Screen.cpp:379
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Screen.cpp:700
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Screen.cpp:664
ome::compat::shared_ptr< std::string > protocolIdentifier
ProtocolIdentifier property.
Definition: Screen.h:88
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: Screen.cpp:676
ome::compat::shared_ptr< std::string > name
Name property.
Definition: Screen.h:84
std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > >::size_type sizeOfReagentList() const
Get size of linked Reagent list.
Definition: Screen.cpp:540
ome::compat::shared_ptr< std::string > getProtocolDescription()
Get the ProtocolDescription property.
Definition: Screen.cpp:400
void setReagent(std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Set Reagent.
Definition: Screen.cpp:570
ome::compat::shared_ptr< std::string > description
Description property.
Definition: Screen.h:98
virtual ~Screen()
Destructor.
Definition: Screen.cpp:170
void setReagentSetIdentifier(ome::compat::shared_ptr< std::string > &reagentSetIdentifier)
Set the ReagentSetIdentifier property.
Definition: Screen.cpp:512
void removeReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Remove Reagent.
Definition: Screen.cpp:587
void setProtocolDescription(ome::compat::shared_ptr< std::string > &protocolDescription)
Set the ProtocolDescription property.
Definition: Screen.cpp:414
ome::compat::shared_ptr< std::string > protocolDescription
ProtocolDescription property.
Definition: Screen.h:86
bool linkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Link Plate.
Definition: Screen.cpp:626
ome::compat::shared_ptr< std::string > getReagentSetIdentifier()
Get the ReagentSetIdentifier property.
Definition: Screen.cpp:498
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Screen.cpp:519
std::string id
ID property.
Definition: Screen.h:94
void setProtocolIdentifier(ome::compat::shared_ptr< std::string > &protocolIdentifier)
Set the ProtocolIdentifier property.
Definition: Screen.cpp:435
ome::compat::shared_ptr< std::string > reagentSetIdentifier
ReagentSetIdentifier property.
Definition: Screen.h:96
void setType(ome::compat::shared_ptr< std::string > &type)
Set the Type property.
Definition: Screen.cpp:477
ome::compat::shared_ptr< std::string > getProtocolIdentifier()
Get the ProtocolIdentifier property.
Definition: Screen.cpp:421
bool unlinkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Unlink Plate.
Definition: Screen.cpp:640
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Screen.cpp:718
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Screen.cpp:658
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Screen.h:104
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: Screen.cpp:670
Boost.Log compatibility.
void setReagentSetDescription(ome::compat::shared_ptr< std::string > &reagentSetDescription)
Set the ReagentSetDescription property.
Definition: Screen.cpp:456
std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > > reagents
Reagent property (occurs more than once)
Definition: Screen.h:100
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Screen.cpp:191
Xerces-C modern C++ wrapper.
Definition: Base.h:53
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateList() const
Get size of linked Plate list.
Definition: Screen.cpp:598
void setID(const std::string &id)
Set the ID property.
Definition: Screen.cpp:491