bioformats  5.1.8
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/Instrument.h>
63 #include <ome/xml/model/ManufacturerSpec.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class FilterSet;
74  class LightPath;
75  class OMEModel;
76 
80  class Dichroic : public ManufacturerSpec
81  {
82  private:
83  class Impl;
85  ome::compat::shared_ptr<Impl> impl;
86 
87  public:
89  Dichroic();
90 
96  Dichroic (const Dichroic& copy);
97 
99  virtual
100  ~Dichroic ();
101 
116  static ome::compat::shared_ptr< Dichroic>
117  create(const common::xml::dom::Element& element,
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,
135 
136  public:
137  // -- Dichroic 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  const std::string&
150  getID () const;
151 
157  void
158  setID (const std::string& id);
159 
165  ome::compat::weak_ptr<ome::xml::model::Instrument>
166  getInstrument ();
167 
173  const ome::compat::weak_ptr<ome::xml::model::Instrument>
174  getInstrument () const;
175 
181  void
182  setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
183 
190  sizeOfLinkedFilterSetList () const;
191 
198  getLinkedFilterSetList () const;
199 
207  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
209 
220  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
222  const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
223 
234  bool
235  linkFilterSet (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
236 
252  bool
253  unlinkFilterSet (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
254 
261  sizeOfLinkedLightPathList () const;
262 
269  getLinkedLightPathList () const;
270 
278  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
280 
291  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
293  const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
294 
305  bool
306  linkLightPath (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
307 
323  bool
324  unlinkLightPath (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
325 
326 
329  asXMLElement (common::xml::dom::Document& document) const;
330 
331 
332  protected:
333  // Documented in base class.
336  common::xml::dom::Element& element) const;
337 
338  public:
339  // Documented in superclass.
340  const std::string&
341  getXMLNamespace() const;
342  };
343 
344  }
345  }
346 }
347 
348 #endif // OME_XML_MODEL_DICHROIC_H
349 
350 /*
351  * Local Variables:
352  * mode:C++
353  * End:
354  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dichroic.h:83
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:383
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:376
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathList() const
Get the linked LightPath list.
Definition: Dichroic.cpp:324
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:278
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Dichroic.cpp:253
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
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
Private implementation details of Dichroic model object.
Definition: Dichroic.cpp:73
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetList() const
Get the linked FilterSet list.
Definition: Dichroic.cpp:266
bool linkLightPath(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPath.
Definition: Dichroic.cpp:346
bool unlinkLightPath(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPath.
Definition: Dichroic.cpp:359
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:330
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
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:260
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
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:272
const std::string & elementName() const
Get the element name of this model object.
Definition: Dichroic.cpp:167
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:183
Dichroic()
Default constructor.
Definition: Dichroic.cpp:134
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dichroic.cpp:174
void setID(const std::string &id)
Set the ID property.
Definition: Dichroic.cpp:232
Dichroic model object.
Definition: Dichroic.h:80
bool unlinkFilterSet(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSet.
Definition: Dichroic.cpp:301
bool linkFilterSet(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSet.
Definition: Dichroic.cpp:288
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
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:336
virtual ~Dichroic()
Destructor.
Definition: Dichroic.cpp:153
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:158
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dichroic.cpp:413
Boost.Log compatibility.
const std::string & getID() const
Get the ID property.
Definition: Dichroic.cpp:225
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:318
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Dichroic.cpp:239
Xerces-C modern C++ wrapper.
Definition: Base.h:53
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:210