46 #ifndef OME_XML_MODEL_LIGHTPATH_H 47 #define OME_XML_MODEL_LIGHTPATH_H 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> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Dichroic.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 87 ome::compat::shared_ptr<Impl>
impl;
118 static ome::compat::shared_ptr< LightPath>
148 link (ome::compat::shared_ptr<Reference>& reference,
149 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
174 const ome::compat::weak_ptr<ome::xml::model::Filter>&
187 const ome::compat::weak_ptr<ome::xml::model::Filter>&
189 const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
202 linkExcitationFilter (
const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
228 ome::compat::weak_ptr<ome::xml::model::Dichroic>
237 const ome::compat::weak_ptr<ome::xml::model::Dichroic>
246 linkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
258 unlinkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
283 const ome::compat::weak_ptr<ome::xml::model::Filter>&
296 const ome::compat::weak_ptr<ome::xml::model::Filter>&
298 const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
311 linkEmissionFilter (
const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
354 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
367 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
369 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
382 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
400 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
423 #endif // OME_XML_MODEL_LIGHTPATH_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: LightPath.cpp:513
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExcitationFilterList() const
Get size of linked ExcitationFilter list.
Definition: LightPath.cpp:322
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: LightPath.cpp:248
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedEmissionFilterList() const
Get the linked EmissionFilter list.
Definition: LightPath.cpp:417
const ome::compat::weak_ptr< ome::xml::model::Filter > & getLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index) const
Get linked ExcitationFilter.
Definition: LightPath.cpp:334
ome::compat::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: LightPath.cpp:382
const ome::compat::weak_ptr< ome::xml::model::Filter > & setLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Set linked ExcitationFilter.
Definition: LightPath.cpp:340
const ome::compat::weak_ptr< ome::xml::model::Filter > & setLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Set linked EmissionFilter.
Definition: LightPath.cpp:429
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void unlinkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Unlink Dichroic.
Definition: LightPath.cpp:401
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
static ome::compat::shared_ptr< LightPath > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a LightPath model object from DOM element.
Definition: LightPath.cpp:162
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: LightPath.cpp:537
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightPath.cpp:178
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: LightPath.cpp:483
LightPath & operator=(const LightPath &)
Assignment operator (deleted).
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedEmissionFilterList() const
Get size of linked EmissionFilter list.
Definition: LightPath.cpp:411
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: LightPath.cpp:471
virtual ~LightPath()
Destructor.
Definition: LightPath.cpp:157
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
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: LightPath.cpp:489
Open Microscopy Environment C++ implementation.
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: LightPath.cpp:530
bool linkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Link ExcitationFilter.
Definition: LightPath.cpp:350
void linkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: LightPath.cpp:395
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: LightPath.cpp:477
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: LightPath.cpp:499
LightPath()
Default constructor.
Definition: LightPath.cpp:138
const ome::compat::weak_ptr< ome::xml::model::Filter > & getLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index) const
Get linked EmissionFilter.
Definition: LightPath.cpp:423
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: LightPath.cpp:186
LightPath model object.
Definition: LightPath.h:82
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightPath.cpp:634
Private implementation details of LightPath model object.
Definition: LightPath.cpp:78
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightPath.h:85
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedExcitationFilterList() const
Get the linked ExcitationFilter list.
Definition: LightPath.cpp:328
const std::string & elementName() const
Get the element name of this model object.
Definition: LightPath.cpp:171
bool linkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: LightPath.cpp:439
bool unlinkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Unlink EmissionFilter.
Definition: LightPath.cpp:453
bool unlinkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: LightPath.cpp:364