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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/Dichroic.h> 64 #include <ome/xml/model/detail/OMEModelObject.h> 86 std::shared_ptr<Impl>
impl;
117 static std::shared_ptr<LightPath>
147 link (std::shared_ptr<Reference>& reference,
148 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
173 const std::weak_ptr<ome::xml::model::Filter>&
186 const std::weak_ptr<ome::xml::model::Filter>&
188 const std::shared_ptr<ome::xml::model::Filter>& excitationFilter);
227 std::weak_ptr<ome::xml::model::Dichroic>
236 const std::weak_ptr<ome::xml::model::Dichroic>
245 linkDichroic (std::shared_ptr<ome::xml::model::Dichroic>& dichroic);
257 unlinkDichroic (std::shared_ptr<ome::xml::model::Dichroic>& dichroic);
282 const std::weak_ptr<ome::xml::model::Filter>&
295 const std::weak_ptr<ome::xml::model::Filter>&
297 const std::shared_ptr<ome::xml::model::Filter>& emissionFilter);
353 const std::weak_ptr<ome::xml::model::Annotation>&
366 const std::weak_ptr<ome::xml::model::Annotation>&
368 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
381 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
399 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
417 #endif // OME_XML_MODEL_LIGHTPATH_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightPath.cpp:174
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type getLinkedExcitationFilterList() const
Get the linked ExcitationFilter list.
Definition: LightPath.cpp:314
static std::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:158
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: LightPath.cpp:485
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 > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const std::weak_ptr< ome::xml::model::Filter > & setLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Set linked EmissionFilter.
Definition: LightPath.cpp:415
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type sizeOfLinkedEmissionFilterList() const
Get size of linked EmissionFilter list.
Definition: LightPath.cpp:397
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: LightPath.cpp:463
LightPath & operator=(const LightPath &)
Assignment operator (deleted).
const std::string & elementName() const
Get the element name of this model object.
Definition: LightPath.cpp:167
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: LightPath.cpp:234
virtual ~LightPath()
Destructor.
Definition: LightPath.cpp:153
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: LightPath.cpp:469
const std::weak_ptr< ome::xml::model::Filter > & setLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Set linked ExcitationFilter.
Definition: LightPath.cpp:326
Open Microscopy Environment C++ implementation.
bool linkExcitationFilter(const std::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Link ExcitationFilter.
Definition: LightPath.cpp:336
void unlinkDichroic(std::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Unlink Dichroic.
Definition: LightPath.cpp:387
void linkDichroic(std::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: LightPath.cpp:381
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type getLinkedEmissionFilterList() const
Get the linked EmissionFilter list.
Definition: LightPath.cpp:403
const std::weak_ptr< ome::xml::model::Filter > & getLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index) const
Get linked EmissionFilter.
Definition: LightPath.cpp:409
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type sizeOfLinkedExcitationFilterList() const
Get size of linked ExcitationFilter list.
Definition: LightPath.cpp:308
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: LightPath.cpp:499
LightPath()
Default constructor.
Definition: LightPath.cpp:138
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: LightPath.cpp:475
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightPath.cpp:605
std::shared_ptr< Impl > impl
Private implementation details.
Definition: LightPath.h:84
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:180
bool unlinkEmissionFilter(const std::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Unlink EmissionFilter.
Definition: LightPath.cpp:439
bool linkEmissionFilter(const std::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: LightPath.cpp:425
LightPath model object.
Definition: LightPath.h:81
bool unlinkExcitationFilter(const std::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: LightPath.cpp:350
virtual void 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:516
std::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: LightPath.cpp:368
Private implementation details of LightPath model object.
Definition: LightPath.cpp:78
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: LightPath.cpp:457
const std::weak_ptr< ome::xml::model::Filter > & getLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index) const
Get linked ExcitationFilter.
Definition: LightPath.cpp:320