ome-xml 5.2.3

Dichroic.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_DICHROIC_H
47 #define OME_XML_MODEL_DICHROIC_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/Instrument.h>
65 #include <ome/xml/model/ManufacturerSpec.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class Annotation;
76 class FilterSet;
77 class LightPath;
78 class OMEModel;
79
83 class Dichroic : public ManufacturerSpec
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 Dichroic();
93
99 Dichroic (const Dichroic& copy);
100
102 virtual
103 ~Dichroic ();
104
119 static ome::compat::shared_ptr< Dichroic>
120 create(const common::xml::dom::Element& element,
121 ome::xml::model::OMEModel& model);
122
123 // Documented in superclass.
124 const std::string&
125 elementName() const;
126
127 // Documented in superclass.
128 bool
129 validElementName(const std::string& name) const;
130
131 private:
133 Dichroic&
134 operator= (const Dichroic&);
135
136 public:
137 // -- OMEModelObject API methods --
138
140 virtual void
141 update(const common::xml::dom::Element& element,
142 ome::xml::model::OMEModel& model);
143
144 public:
145 // -- Dichroic API methods --
146
148 bool
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
151
157 const std::string&
158 getID () const;
159
165 void
166 setID (const std::string& id);
167
173 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
174 sizeOfLinkedAnnotationList () const;
175
181 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
182 getLinkedAnnotationList () const;
183
191 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
192 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
193
204 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
205 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
206 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
207
218 bool
219 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
220
236 bool
237 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
238
244 ome::compat::weak_ptr<ome::xml::model::Instrument>
245 getInstrument ();
246
252 const ome::compat::weak_ptr<ome::xml::model::Instrument>
253 getInstrument () const;
254
260 void
261 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
262
268 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type
269 sizeOfLinkedFilterSetList () const;
270
276 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type
277 getLinkedFilterSetList () const;
278
286 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
287 getLinkedFilterSet (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index) const;
288
299 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
300 setLinkedFilterSet (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index,
301 const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
302
313 bool
314 linkFilterSet (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
315
331 bool
332 unlinkFilterSet (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
333
339 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type
340 sizeOfLinkedLightPathList () const;
341
347 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type
348 getLinkedLightPathList () const;
349
357 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
358 getLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index) const;
359
370 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
371 setLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index,
372 const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
373
384 bool
385 linkLightPath (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
386
402 bool
403 unlinkLightPath (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
404
406 virtual common::xml::dom::Element
407 asXMLElement (common::xml::dom::Document& document) const;
408
409
410 protected:
411 // Documented in base class.
412 virtual common::xml::dom::Element
413 asXMLElementInternal (common::xml::dom::Document& document,
414 common::xml::dom::Element& element) const;
415
416 public:
417 // Documented in superclass.
418 const std::string&
419 getXMLNamespace() const;
420 };
421
422 }
423 }
424 }
425
426 #endif // OME_XML_MODEL_DICHROIC_H
427
428 /*
429 * Local Variables:
430 * mode:C++
431 * End:
432 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Dichroic::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dichroic.h:86
ome::xml::model::Dichroic::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Dichroic.cpp:171
ome::xml::model::Dichroic::operator=
Dichroic & operator=(const Dichroic &)
Assignment operator (deleted).
ome::xml::model::Dichroic::setLinkedFilterSet
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSet(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Set linked FilterSet.
Definition: Dichroic.cpp:370
ome::xml::model::Dichroic::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: Dichroic.cpp:474
ome::xml::model::Dichroic::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: Dichroic.cpp:283
ome::xml::model::Dichroic::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Dichroic.cpp:345
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Dichroic::getLinkedLightPath
const ome::compat::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPath(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index) const
Get linked LightPath.
Definition: Dichroic.cpp:422
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::Dichroic::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dichroic.cpp:277
ome::xml::model::Dichroic::Impl
Private implementation details of Dichroic model object.
Definition: Dichroic.cpp:75
ome::xml::model::Dichroic::sizeOfLinkedLightPathList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLightPathList() const
Get size of linked LightPath list.
Definition: Dichroic.cpp:410
ome::xml::model::Dichroic::linkLightPath
bool linkLightPath(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPath.
Definition: Dichroic.cpp:438
ome::xml::model::Dichroic::unlinkLightPath
bool unlinkLightPath(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPath.
Definition: Dichroic.cpp:451
ome::xml::model::Dichroic::getLinkedFilterSet
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSet(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index) const
Get linked FilterSet.
Definition: Dichroic.cpp:364
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Dichroic::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: Dichroic.cpp:186
ome::xml::model::Dichroic::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dichroic.cpp:526
ome::xml::model::Dichroic::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dichroic.cpp:299
ome::xml::model::Dichroic::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Dichroic.cpp:271
ome::xml::model::Dichroic::Dichroic
Dichroic()
Default constructor.
Definition: Dichroic.cpp:142
ome::xml::model::Dichroic::getLinkedFilterSetList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetList() const
Get the linked FilterSet list.
Definition: Dichroic.cpp:358
ome::xml::model::Dichroic::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: Dichroic.cpp:289
ome::xml::model::Dichroic::setID
void setID(const std::string &id)
Set the ID property.
Definition: Dichroic.cpp:264
ome::xml::model::Dichroic::getID
const std::string & getID() const
Get the ID property.
Definition: Dichroic.cpp:257
ome::xml::model::Dichroic
Dichroic model object.
Definition: Dichroic.h:83
ome::xml::model::Dichroic::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dichroic.cpp:313
ome::xml::model::Dichroic::unlinkFilterSet
bool unlinkFilterSet(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSet.
Definition: Dichroic.cpp:393
ome::xml::model::Dichroic::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Dichroic.cpp:467
ome::xml::model::Dichroic::linkFilterSet
bool linkFilterSet(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSet.
Definition: Dichroic.cpp:380
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
ome::xml::model::Dichroic::setLinkedLightPath
const ome::compat::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPath(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPath.
Definition: Dichroic.cpp:428
ome::xml::model::Dichroic::~Dichroic
virtual ~Dichroic()
Destructor.
Definition: Dichroic.cpp:157
ome::xml::model::Dichroic::getLinkedLightPathList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathList() const
Get the linked LightPath list.
Definition: Dichroic.cpp:416
ome::xml::model::Dichroic::create
static ome::compat::shared_ptr< Dichroic > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Dichroic model object from DOM element.
Definition: Dichroic.cpp:162
ome::xml::model::Dichroic::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dichroic.cpp:178
ome::xml::model::Dichroic::sizeOfLinkedFilterSetList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFilterSetList() const
Get size of linked FilterSet list.
Definition: Dichroic.cpp:352
log.h
ome::xml::model::Dichroic::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Dichroic.cpp:331
ome::xml::model::Dichroic::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: Dichroic.cpp:226