ome-xml 5.2.3

Instrument.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_INSTRUMENT_H
47 #define OME_XML_MODEL_INSTRUMENT_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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Microscope.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class Annotation;
76 class Detector;
77 class Dichroic;
78 class Filter;
79 class FilterSet;
80 class Image;
81 class LightSource;
82 class OMEModel;
83 class Objective;
84
88 class Instrument : public detail::OMEModelObject
89 {
90 private:
91 class Impl;
93 ome::compat::shared_ptr<Impl> impl;
94
95 public:
97 Instrument();
98
104 Instrument (const Instrument& copy);
105
107 virtual
108 ~Instrument ();
109
124 static ome::compat::shared_ptr< Instrument>
125 create(const common::xml::dom::Element& element,
126 ome::xml::model::OMEModel& model);
127
128 // Documented in superclass.
129 const std::string&
130 elementName() const;
131
132 // Documented in superclass.
133 bool
134 validElementName(const std::string& name) const;
135
136 private:
138 Instrument&
139 operator= (const Instrument&);
140
141 public:
142 // -- OMEModelObject API methods --
143
145 virtual void
146 update(const common::xml::dom::Element& element,
147 ome::xml::model::OMEModel& model);
148
149 public:
150 // -- Instrument API methods --
151
153 bool
154 link (ome::compat::shared_ptr<Reference>& reference,
155 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
156
162 const std::string&
163 getID () const;
164
170 void
171 setID (const std::string& id);
172
178 ome::compat::shared_ptr<ome::xml::model::Microscope>
179 getMicroscope ();
180
186 const ome::compat::shared_ptr<ome::xml::model::Microscope>
187 getMicroscope () const;
188
194 void
195 setMicroscope (ome::compat::shared_ptr<ome::xml::model::Microscope>& microscope);
196
202 std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >::size_type
203 sizeOfLightSourceList () const;
204
211 std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >&
212 getLightSourceList ();
213
220 const std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >&
221 getLightSourceList () const;
222
230 ome::compat::shared_ptr<ome::xml::model::LightSource>&
231 getLightSource (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >::size_type index);
232
240 const ome::compat::shared_ptr<ome::xml::model::LightSource>&
241 getLightSource (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >::size_type index) const;
242
250 void
251 setLightSource (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSource> >::size_type index,
252 ome::compat::shared_ptr<ome::xml::model::LightSource>& lightSource);
253
262 void
263 addLightSource (ome::compat::shared_ptr<ome::xml::model::LightSource>& lightSource);
264
274 void
275 removeLightSource (ome::compat::shared_ptr<ome::xml::model::LightSource>& lightSource);
276
282 std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >::size_type
283 sizeOfDetectorList () const;
284
291 std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >&
292 getDetectorList ();
293
300 const std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >&
301 getDetectorList () const;
302
310 ome::compat::shared_ptr<ome::xml::model::Detector>&
311 getDetector (std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >::size_type index);
312
320 const ome::compat::shared_ptr<ome::xml::model::Detector>&
321 getDetector (std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >::size_type index) const;
322
330 void
331 setDetector (std::vector<ome::compat::shared_ptr<ome::xml::model::Detector> >::size_type index,
332 ome::compat::shared_ptr<ome::xml::model::Detector>& detector);
333
342 void
343 addDetector (ome::compat::shared_ptr<ome::xml::model::Detector>& detector);
344
354 void
355 removeDetector (ome::compat::shared_ptr<ome::xml::model::Detector>& detector);
356
362 std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >::size_type
363 sizeOfObjectiveList () const;
364
371 std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >&
372 getObjectiveList ();
373
380 const std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >&
381 getObjectiveList () const;
382
390 ome::compat::shared_ptr<ome::xml::model::Objective>&
391 getObjective (std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >::size_type index);
392
400 const ome::compat::shared_ptr<ome::xml::model::Objective>&
401 getObjective (std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >::size_type index) const;
402
410 void
411 setObjective (std::vector<ome::compat::shared_ptr<ome::xml::model::Objective> >::size_type index,
412 ome::compat::shared_ptr<ome::xml::model::Objective>& objective);
413
422 void
423 addObjective (ome::compat::shared_ptr<ome::xml::model::Objective>& objective);
424
434 void
435 removeObjective (ome::compat::shared_ptr<ome::xml::model::Objective>& objective);
436
442 std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >::size_type
443 sizeOfFilterSetList () const;
444
451 std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >&
452 getFilterSetList ();
453
460 const std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >&
461 getFilterSetList () const;
462
470 ome::compat::shared_ptr<ome::xml::model::FilterSet>&
471 getFilterSet (std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >::size_type index);
472
480 const ome::compat::shared_ptr<ome::xml::model::FilterSet>&
481 getFilterSet (std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >::size_type index) const;
482
490 void
491 setFilterSet (std::vector<ome::compat::shared_ptr<ome::xml::model::FilterSet> >::size_type index,
492 ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);
493
502 void
503 addFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);
504
514 void
515 removeFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);
516
522 std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >::size_type
523 sizeOfFilterList () const;
524
531 std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >&
532 getFilterList ();
533
540 const std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >&
541 getFilterList () const;
542
550 ome::compat::shared_ptr<ome::xml::model::Filter>&
551 getFilter (std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >::size_type index);
552
560 const ome::compat::shared_ptr<ome::xml::model::Filter>&
561 getFilter (std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >::size_type index) const;
562
570 void
571 setFilter (std::vector<ome::compat::shared_ptr<ome::xml::model::Filter> >::size_type index,
572 ome::compat::shared_ptr<ome::xml::model::Filter>& filter);
573
582 void
583 addFilter (ome::compat::shared_ptr<ome::xml::model::Filter>& filter);
584
594 void
595 removeFilter (ome::compat::shared_ptr<ome::xml::model::Filter>& filter);
596
602 std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >::size_type
603 sizeOfDichroicList () const;
604
611 std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >&
612 getDichroicList ();
613
620 const std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >&
621 getDichroicList () const;
622
630 ome::compat::shared_ptr<ome::xml::model::Dichroic>&
631 getDichroic (std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >::size_type index);
632
640 const ome::compat::shared_ptr<ome::xml::model::Dichroic>&
641 getDichroic (std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >::size_type index) const;
642
650 void
651 setDichroic (std::vector<ome::compat::shared_ptr<ome::xml::model::Dichroic> >::size_type index,
652 ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
653
662 void
663 addDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
664
674 void
675 removeDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
676
682 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
683 sizeOfLinkedAnnotationList () const;
684
690 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
691 getLinkedAnnotationList () const;
692
700 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
701 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
702
713 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
714 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
715 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
716
727 bool
728 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
729
745 bool
746 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
747
753 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
754 sizeOfLinkedImageList () const;
755
761 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
762 getLinkedImageList () const;
763
771 const ome::compat::weak_ptr<ome::xml::model::Image>&
772 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
773
784 const ome::compat::weak_ptr<ome::xml::model::Image>&
785 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
786 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
787
798 bool
799 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
800
816 bool
817 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
818
820 virtual common::xml::dom::Element
821 asXMLElement (common::xml::dom::Document& document) const;
822
823
824 protected:
825 // Documented in base class.
826 virtual common::xml::dom::Element
827 asXMLElementInternal (common::xml::dom::Document& document,
828 common::xml::dom::Element& element) const;
829
830 public:
831 // Documented in superclass.
832 const std::string&
833 getXMLNamespace() const;
834 };
835
836 }
837 }
838 }
839
840 #endif // OME_XML_MODEL_INSTRUMENT_H
841
842 /*
843 * Local Variables:
844 * mode:C++
845 * End:
846 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Instrument::setMicroscope
void setMicroscope(ome::compat::shared_ptr< ome::xml::model::Microscope > &microscope)
Set the Microscope property.
Definition: Instrument.cpp:460
ome::xml::model::Instrument::getFilterSetList
std::vector< ome::compat::shared_ptr< ome::xml::model::FilterSet > > & getFilterSetList()
Get the FilterSet list.
Definition: Instrument.cpp:647
ome::xml::model::Instrument::sizeOfDetectorList
std::vector< ome::compat::shared_ptr< ome::xml::model::Detector > >::size_type sizeOfDetectorList() const
Get size of linked Detector list.
Definition: Instrument.cpp:525
ome::xml::model::Instrument
Instrument model object.
Definition: Instrument.h:88
ome::xml::model::Instrument::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Instrument.h:91
ome::xml::model::Instrument::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Instrument.cpp:932
ome::xml::model::Instrument::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Instrument.cpp:815
ome::xml::model::Instrument::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Instrument.cpp:903
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Instrument::~Instrument
virtual ~Instrument()
Destructor.
Definition: Instrument.cpp:217
ome::xml::model::Instrument::removeFilterSet
void removeFilterSet(ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Remove FilterSet.
Definition: Instrument.cpp:688
ome::xml::model::Instrument::addDichroic
void addDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Add Dichroic.
Definition: Instrument.cpp:796
ome::xml::model::Instrument::getFilterList
std::vector< ome::compat::shared_ptr< ome::xml::model::Filter > > & getFilterList()
Get the Filter list.
Definition: Instrument.cpp:705
ome::xml::model::Instrument::addFilter
void addFilter(ome::compat::shared_ptr< ome::xml::model::Filter > &filter)
Add Filter.
Definition: Instrument.cpp:738
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Instrument::setID
void setID(const std::string &id)
Set the ID property.
Definition: Instrument.cpp:439
ome::xml::model::Instrument::removeFilter
void removeFilter(ome::compat::shared_ptr< ome::xml::model::Filter > &filter)
Remove Filter.
Definition: Instrument.cpp:746
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::Instrument::sizeOfObjectiveList
std::vector< ome::compat::shared_ptr< ome::xml::model::Objective > >::size_type sizeOfObjectiveList() const
Get size of linked Objective list.
Definition: Instrument.cpp:583
ome::xml::model::Instrument::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Instrument.cpp:857
ome::xml::model::Instrument::addFilterSet
void addFilterSet(ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Add FilterSet.
Definition: Instrument.cpp:680
ome::xml::model::Instrument::sizeOfFilterSetList
std::vector< ome::compat::shared_ptr< ome::xml::model::FilterSet > >::size_type sizeOfFilterSetList() const
Get size of linked FilterSet list.
Definition: Instrument.cpp:641
ome::xml::model::Instrument::addObjective
void addObjective(ome::compat::shared_ptr< ome::xml::model::Objective > &objective)
Add Objective.
Definition: Instrument.cpp:622
ome::xml::model::Instrument::getDichroicList
std::vector< ome::compat::shared_ptr< ome::xml::model::Dichroic > > & getDichroicList()
Get the Dichroic list.
Definition: Instrument.cpp:763
ome::xml::model::Instrument::sizeOfDichroicList
std::vector< ome::compat::shared_ptr< ome::xml::model::Dichroic > >::size_type sizeOfDichroicList() const
Get size of linked Dichroic list.
Definition: Instrument.cpp:757
ome::xml::model::Instrument::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: Instrument.cpp:246
ome::xml::model::Instrument::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Instrument.cpp:916
ome::xml::model::Instrument::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: Instrument.cpp:401
ome::xml::model::Instrument::Impl
Private implementation details of Instrument model object.
Definition: Instrument.cpp:100
ome::xml::model::Instrument::setDichroic
void setDichroic(std::vector< ome::compat::shared_ptr< ome::xml::model::Dichroic > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Set Dichroic.
Definition: Instrument.cpp:787
ome::xml::model::Instrument::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Instrument.cpp:231
ome::xml::model::Instrument::getObjective
ome::compat::shared_ptr< ome::xml::model::Objective > & getObjective(std::vector< ome::compat::shared_ptr< ome::xml::model::Objective > >::size_type index)
Get Objective.
Definition: Instrument.cpp:601
ome::xml::model::Instrument::getLinkedImage
const ome::compat::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Instrument.cpp:887
ome::xml::model::Instrument::getDetectorList
std::vector< ome::compat::shared_ptr< ome::xml::model::Detector > > & getDetectorList()
Get the Detector list.
Definition: Instrument.cpp:531
ome::xml::model::Instrument::getObjectiveList
std::vector< ome::compat::shared_ptr< ome::xml::model::Objective > > & getObjectiveList()
Get the Objective list.
Definition: Instrument.cpp:589
ome::xml::model::Instrument::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: Instrument.cpp:827
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::Instrument::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: Instrument.cpp:939
ome::xml::model::Instrument::getFilterSet
ome::compat::shared_ptr< ome::xml::model::FilterSet > & getFilterSet(std::vector< ome::compat::shared_ptr< ome::xml::model::FilterSet > >::size_type index)
Get FilterSet.
Definition: Instrument.cpp:659
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Instrument::addDetector
void addDetector(ome::compat::shared_ptr< ome::xml::model::Detector > &detector)
Add Detector.
Definition: Instrument.cpp:564
ome::xml::model::Instrument::getID
const std::string & getID() const
Get the ID property.
Definition: Instrument.cpp:432
ome::xml::model::Instrument::getLightSource
ome::compat::shared_ptr< ome::xml::model::LightSource > & getLightSource(std::vector< ome::compat::shared_ptr< ome::xml::model::LightSource > >::size_type index)
Get LightSource.
Definition: Instrument.cpp:485
ome::xml::model::Instrument::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Instrument.cpp:1092
ome::xml::model::Instrument::setLightSource
void setLightSource(std::vector< ome::compat::shared_ptr< ome::xml::model::LightSource > >::size_type index, ome::compat::shared_ptr< ome::xml::model::LightSource > &lightSource)
Set LightSource.
Definition: Instrument.cpp:497
ome::xml::model::Instrument::removeLightSource
void removeLightSource(ome::compat::shared_ptr< ome::xml::model::LightSource > &lightSource)
Remove LightSource.
Definition: Instrument.cpp:514
ome::xml::model::Instrument::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: Instrument.cpp:833
ome::xml::model::Instrument::getLightSourceList
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSource > > & getLightSourceList()
Get the LightSource list.
Definition: Instrument.cpp:473
ome::xml::model::Instrument::removeDetector
void removeDetector(ome::compat::shared_ptr< ome::xml::model::Detector > &detector)
Remove Detector.
Definition: Instrument.cpp:572
ome::xml::model::Instrument::getDetector
ome::compat::shared_ptr< ome::xml::model::Detector > & getDetector(std::vector< ome::compat::shared_ptr< ome::xml::model::Detector > >::size_type index)
Get Detector.
Definition: Instrument.cpp:543
ome::xml::model::Instrument::setFilter
void setFilter(std::vector< ome::compat::shared_ptr< ome::xml::model::Filter > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Filter > &filter)
Set Filter.
Definition: Instrument.cpp:729
ome::xml::model::Instrument::setObjective
void setObjective(std::vector< ome::compat::shared_ptr< ome::xml::model::Objective > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Objective > &objective)
Set Objective.
Definition: Instrument.cpp:613
ome::xml::model::Instrument::sizeOfLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Instrument.cpp:875
ome::xml::model::Instrument::setLinkedImage
const ome::compat::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: Instrument.cpp:893
ome::xml::model::Instrument::sizeOfFilterList
std::vector< ome::compat::shared_ptr< ome::xml::model::Filter > >::size_type sizeOfFilterList() const
Get size of linked Filter list.
Definition: Instrument.cpp:699
ome::xml::model::Instrument::setFilterSet
void setFilterSet(std::vector< ome::compat::shared_ptr< ome::xml::model::FilterSet > >::size_type index, ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Set FilterSet.
Definition: Instrument.cpp:671
ome::xml::model::Instrument::create
static ome::compat::shared_ptr< Instrument > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Instrument model object from DOM element.
Definition: Instrument.cpp:222
ome::xml::model::Instrument::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Instrument.cpp:238
ome::xml::model::Instrument::sizeOfLightSourceList
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSource > >::size_type sizeOfLightSourceList() const
Get size of linked LightSource list.
Definition: Instrument.cpp:467
ome::xml::model::Instrument::Instrument
Instrument()
Default constructor.
Definition: Instrument.cpp:202
ome::xml::model::Instrument::addLightSource
void addLightSource(ome::compat::shared_ptr< ome::xml::model::LightSource > &lightSource)
Add LightSource.
Definition: Instrument.cpp:506
ome::xml::model::Instrument::removeObjective
void removeObjective(ome::compat::shared_ptr< ome::xml::model::Objective > &objective)
Remove Objective.
Definition: Instrument.cpp:630
log.h
ome::xml::model::Instrument::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Instrument.cpp:821
ome::xml::model::Instrument::getMicroscope
ome::compat::shared_ptr< ome::xml::model::Microscope > getMicroscope()
Get the Microscope property.
Definition: Instrument.cpp:446
ome::xml::model::Instrument::removeDichroic
void removeDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Remove Dichroic.
Definition: Instrument.cpp:804
ome::xml::model::Instrument::operator=
Instrument & operator=(const Instrument &)
Assignment operator (deleted).
ome::xml::model::Instrument::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Instrument.cpp:843
ome::xml::model::Instrument::getFilter
ome::compat::shared_ptr< ome::xml::model::Filter > & getFilter(std::vector< ome::compat::shared_ptr< ome::xml::model::Filter > >::size_type index)
Get Filter.
Definition: Instrument.cpp:717
ome::xml::model::Instrument::getDichroic
ome::compat::shared_ptr< ome::xml::model::Dichroic > & getDichroic(std::vector< ome::compat::shared_ptr< ome::xml::model::Dichroic > >::size_type index)
Get Dichroic.
Definition: Instrument.cpp:775
ome::xml::model::Instrument::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Instrument.cpp:881
ome::xml::model::Instrument::setDetector
void setDetector(std::vector< ome::compat::shared_ptr< ome::xml::model::Detector > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Detector > &detector)
Set Detector.
Definition: Instrument.cpp:555