ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

Screen.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_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
80 class Screen : public detail::OMEModelObject
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 Screen();
90
96 Screen (const Screen& copy);
97
99 virtual
100 ~Screen ();
101
116 static ome::compat::shared_ptr< Screen>
117 create(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
119
120 // Documented in superclass.
121 const std::string&
122 elementName() const;
123
124 // Documented in superclass.
125 bool
126 validElementName(const std::string& name) const;
127
128
129 // -- OMEModelObject API methods --
130
132 virtual void
133 update(const common::xml::dom::Element& element,
134 ome::xml::model::OMEModel& model);
135
136 public:
137 // -- Screen API methods --
138
140 bool
141 link (ome::compat::shared_ptr<Reference>& reference,
142 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
143
149 ome::compat::shared_ptr<std::string>
150 getName ();
151
157 const ome::compat::shared_ptr<std::string>
158 getName () const;
159
165 void
166 setName (ome::compat::shared_ptr<std::string>& name);
167
173 ome::compat::shared_ptr<std::string>
174 getProtocolDescription ();
175
181 const ome::compat::shared_ptr<std::string>
182 getProtocolDescription () const;
183
189 void
190 setProtocolDescription (ome::compat::shared_ptr<std::string>& protocolDescription);
191
197 ome::compat::shared_ptr<std::string>
198 getProtocolIdentifier ();
199
205 const ome::compat::shared_ptr<std::string>
206 getProtocolIdentifier () const;
207
213 void
214 setProtocolIdentifier (ome::compat::shared_ptr<std::string>& protocolIdentifier);
215
221 ome::compat::shared_ptr<std::string>
222 getReagentSetDescription ();
223
229 const ome::compat::shared_ptr<std::string>
230 getReagentSetDescription () const;
231
237 void
238 setReagentSetDescription (ome::compat::shared_ptr<std::string>& reagentSetDescription);
239
245 ome::compat::shared_ptr<std::string>
246 getType ();
247
253 const ome::compat::shared_ptr<std::string>
254 getType () const;
255
261 void
262 setType (ome::compat::shared_ptr<std::string>& type);
263
269 const std::string&
270 getID () const;
271
277 void
278 setID (const std::string& id);
279
285 ome::compat::shared_ptr<std::string>
286 getReagentSetIdentifier ();
287
293 const ome::compat::shared_ptr<std::string>
294 getReagentSetIdentifier () const;
295
301 void
302 setReagentSetIdentifier (ome::compat::shared_ptr<std::string>& reagentSetIdentifier);
303
309 ome::compat::shared_ptr<std::string>
310 getDescription ();
311
317 const ome::compat::shared_ptr<std::string>
318 getDescription () const;
319
325 void
326 setDescription (ome::compat::shared_ptr<std::string>& description);
327
333 std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type
334 sizeOfReagentList () const;
335
342 std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >&
343 getReagentList ();
344
351 const std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >&
352 getReagentList () const;
353
361 ome::compat::shared_ptr<ome::xml::model::Reagent>&
362 getReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index);
363
371 const ome::compat::shared_ptr<ome::xml::model::Reagent>&
372 getReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index) const;
373
381 void
382 setReagent (std::vector<ome::compat::shared_ptr<ome::xml::model::Reagent> >::size_type index,
383 ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
384
393 void
394 addReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
395
405 void
406 removeReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
407
413 OMEModelObject::indexed_container<ome::xml::model::Plate, ome::compat::weak_ptr>::type::size_type
414 sizeOfLinkedPlateList () const;
415
421 OMEModelObject::indexed_container<ome::xml::model::Plate, ome::compat::weak_ptr>::type
422 getLinkedPlateList () const;
423
431 const ome::compat::weak_ptr<ome::xml::model::Plate>&
432 getLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, ome::compat::weak_ptr>::type::size_type index) const;
433
444 const ome::compat::weak_ptr<ome::xml::model::Plate>&
445 setLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, ome::compat::weak_ptr>::type::size_type index,
446 const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
447
458 bool
459 linkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
460
476 bool
477 unlinkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
478
484 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
485 sizeOfLinkedAnnotationList () const;
486
492 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
493 getLinkedAnnotationList () const;
494
502 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
503 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
504
515 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
516 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
517 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
518
529 bool
530 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
531
547 bool
548 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
549
550
552 virtual common::xml::dom::Element
553 asXMLElement (common::xml::dom::Document& document) const;
554
555
556 protected:
557 // Documented in base class.
558 virtual common::xml::dom::Element
559 asXMLElementInternal (common::xml::dom::Document& document,
560 common::xml::dom::Element& element) const;
561
562 public:
563 // Documented in superclass.
564 const std::string&
565 getXMLNamespace() const;
566 };
567
568 }
569 }
570 }
571
572 #endif // OME_XML_MODEL_SCREEN_H
573
574 /*
575 * Local Variables:
576 * mode:C++
577 * End:
578 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Screen::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Screen.cpp:219
ome::xml::model::Screen::getID
const std::string & getID() const
Get the ID property.
Definition: Screen.cpp:519
ome::xml::model::Screen::getReagentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > > & getReagentList()
Get the Reagent list.
Definition: Screen.cpp:581
ome::xml::model::Screen::getLinkedPlate
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:645
ome::xml::model::Screen::getType
ome::compat::shared_ptr< std::string > getType()
Get the Type property.
Definition: Screen.cpp:498
ome::xml::model::Screen::getReagent
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:593
ome::xml::model::Screen::setLinkedPlate
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:651
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Screen::getReagentSetDescription
ome::compat::shared_ptr< std::string > getReagentSetDescription()
Get the ReagentSetDescription property.
Definition: Screen.cpp:477
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Screen::Screen
Screen()
Default constructor.
Definition: Screen.cpp:186
ome::xml::model::OMEModelObject::indexed_container::type
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
ome::xml::model::Screen::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Screen.cpp:568
ome::xml::model::Screen::update
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:235
ome::xml::model::Screen::asXMLElementInternal
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:760
ome::xml::model::Screen::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Screen.cpp:721
ome::xml::model::Screen::getLinkedPlateList
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Screen.cpp:639
ome::xml::model::Screen::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Screen.cpp:428
ome::xml::model::Screen::link
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:367
ome::xml::model::Screen::addReagent
void addReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Add Reagent.
Definition: Screen.cpp:614
ome::xml::model::Screen
Screen model object.
Definition: Screen.h:80
ome::xml::model::Screen::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Screen.cpp:931
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Screen::create
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:210
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Screen::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Screen.cpp:414
ome::xml::model::Screen::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Screen.cpp:735
ome::xml::model::Screen::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Screen.cpp:699
ome::xml::model::Screen::setLinkedAnnotation
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:711
ome::xml::model::Screen::sizeOfReagentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Reagent > >::size_type sizeOfReagentList() const
Get size of linked Reagent list.
Definition: Screen.cpp:575
ome::xml::model::Screen::getProtocolDescription
ome::compat::shared_ptr< std::string > getProtocolDescription()
Get the ProtocolDescription property.
Definition: Screen.cpp:435
ome::xml::model::Screen::setReagent
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:605
ome::xml::model::Screen::~Screen
virtual ~Screen()
Destructor.
Definition: Screen.cpp:205
ome::xml::model::Screen::setReagentSetIdentifier
void setReagentSetIdentifier(ome::compat::shared_ptr< std::string > &reagentSetIdentifier)
Set the ReagentSetIdentifier property.
Definition: Screen.cpp:547
ome::xml::model::Screen::removeReagent
void removeReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Remove Reagent.
Definition: Screen.cpp:622
ome::xml::model::Screen::setProtocolDescription
void setProtocolDescription(ome::compat::shared_ptr< std::string > &protocolDescription)
Set the ProtocolDescription property.
Definition: Screen.cpp:449
ome::xml::model::Screen::linkPlate
bool linkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Link Plate.
Definition: Screen.cpp:661
ome::xml::model::Screen::getReagentSetIdentifier
ome::compat::shared_ptr< std::string > getReagentSetIdentifier()
Get the ReagentSetIdentifier property.
Definition: Screen.cpp:533
ome::xml::model::Screen::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Screen.cpp:554
ome::xml::model::Screen::setProtocolIdentifier
void setProtocolIdentifier(ome::compat::shared_ptr< std::string > &protocolIdentifier)
Set the ProtocolIdentifier property.
Definition: Screen.cpp:470
ome::xml::model::Screen::Impl
Private implementation details of Screen model object.
Definition: Screen.cpp:76
ome::xml::model::Screen::setType
void setType(ome::compat::shared_ptr< std::string > &type)
Set the Type property.
Definition: Screen.cpp:512
ome::xml::model::Screen::getProtocolIdentifier
ome::compat::shared_ptr< std::string > getProtocolIdentifier()
Get the ProtocolIdentifier property.
Definition: Screen.cpp:456
ome::xml::model::Screen::unlinkPlate
bool unlinkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Unlink Plate.
Definition: Screen.cpp:675
ome::xml::model::Screen::asXMLElement
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:753
ome::xml::model::Screen::sizeOfLinkedAnnotationList
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:693
ome::xml::model::Screen::getLinkedAnnotation
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:705
log.h
ome::xml::model::Screen::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Screen.h:83
ome::xml::model::Screen::setReagentSetDescription
void setReagentSetDescription(ome::compat::shared_ptr< std::string > &reagentSetDescription)
Set the ReagentSetDescription property.
Definition: Screen.cpp:491
ome::xml::model::Screen::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Screen.cpp:226
ome::xml::model::Screen::sizeOfLinkedPlateList
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:633
ome::xml::model::Screen::setID
void setID(const std::string &id)
Set the ID property.
Definition: Screen.cpp:526