46 #ifndef OME_XML_MODEL_CHANNEL_H 47 #define OME_XML_MODEL_CHANNEL_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/DetectorSettings.h> 65 #include <ome/xml/model/FilterSet.h> 66 #include <ome/xml/model/LightPath.h> 67 #include <ome/xml/model/LightSourceSettings.h> 68 #include <ome/xml/model/Pixels.h> 69 #include <ome/xml/model/detail/OMEModelObject.h> 70 #include <ome/xml/model/enums/AcquisitionMode.h> 71 #include <ome/xml/model/enums/ContrastMethod.h> 72 #include <ome/xml/model/enums/IlluminationType.h> 73 #include <ome/xml/model/enums/UnitsLength.h> 74 #include <ome/xml/model/primitives/Color.h> 75 #include <ome/xml/model/primitives/PositiveFloat.h> 76 #include <ome/xml/model/primitives/PositiveInteger.h> 97 ome::compat::shared_ptr<Impl>
impl;
128 static ome::compat::shared_ptr< Channel>
158 link (ome::compat::shared_ptr<Reference>& reference,
159 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
166 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
174 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
190 ome::compat::shared_ptr<std::string>
198 const ome::compat::shared_ptr<std::string>
207 setName (ome::compat::shared_ptr<std::string>& name);
214 ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>
222 const ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>
231 setAcquisitionMode (ome::compat::shared_ptr<ome::xml::model::enums::AcquisitionMode>& acquisitionMode);
238 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
246 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
255 setColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& color);
262 ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>
270 const ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>
279 setContrastMethod (ome::compat::shared_ptr<ome::xml::model::enums::ContrastMethod>& contrastMethod);
286 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
294 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
310 ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>
318 const ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>
327 setIlluminationType (ome::compat::shared_ptr<ome::xml::model::enums::IlluminationType>& illuminationType);
334 ome::compat::shared_ptr<std::string>
342 const ome::compat::shared_ptr<std::string>
351 setFluor (ome::compat::shared_ptr<std::string>& fluor);
358 ome::compat::shared_ptr<int32_t>
366 const ome::compat::shared_ptr<int32_t>
382 ome::compat::shared_ptr<double>
390 const ome::compat::shared_ptr<double>
399 setNDFilter (ome::compat::shared_ptr<double>& ndFilter);
406 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
414 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
439 setID (
const std::string&
id);
446 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
454 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
463 setSamplesPerPixel (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& samplesPerPixel);
470 ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>
478 const ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>
487 setLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
494 ome::compat::shared_ptr<ome::xml::model::DetectorSettings>
502 const ome::compat::shared_ptr<ome::xml::model::DetectorSettings>
511 setDetectorSettings (ome::compat::shared_ptr<ome::xml::model::DetectorSettings>& detectorSettings);
519 ome::compat::weak_ptr<ome::xml::model::FilterSet>
528 const ome::compat::weak_ptr<ome::xml::model::FilterSet>
537 linkFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);
549 unlinkFilterSet (ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet);
574 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
587 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
589 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
602 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
620 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
627 ome::compat::shared_ptr<ome::xml::model::LightPath>
635 const ome::compat::shared_ptr<ome::xml::model::LightPath>
644 setLightPath (ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath);
651 ome::compat::weak_ptr<ome::xml::model::Pixels>
659 const ome::compat::weak_ptr<ome::xml::model::Pixels>
668 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
691 #endif // OME_XML_MODEL_CHANNEL_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setDetectorSettings(ome::compat::shared_ptr< ome::xml::model::DetectorSettings > &detectorSettings)
Set the DetectorSettings property.
Definition: Channel.cpp:866
ome::compat::shared_ptr< std::string > getFluor()
Get the Fluor property.
Definition: Channel.cpp:712
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Channel.cpp:908
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSamplesPerPixel()
Get the SamplesPerPixel property.
Definition: Channel.cpp:810
void setColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Channel.cpp:642
ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > getContrastMethod()
Get the ContrastMethod property.
Definition: Channel.cpp:649
Channel()
Default constructor.
Definition: Channel.cpp:259
void setExcitationWavelength(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &excitationWavelength)
Set the ExcitationWavelength property.
Definition: Channel.cpp:684
void linkFilterSet(ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Link FilterSet.
Definition: Channel.cpp:886
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Channel.cpp:586
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getExcitationWavelength()
Get the ExcitationWavelength property.
Definition: Channel.cpp:670
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Channel.h:95
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: Channel.cpp:303
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Channel.cpp:983
void setSamplesPerPixel(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &samplesPerPixel)
Set the SamplesPerPixel property.
Definition: Channel.cpp:824
virtual ~Channel()
Destructor.
Definition: Channel.cpp:274
const std::string & getID() const
Get the ID property.
Definition: Channel.cpp:796
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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
Channel model object.
Definition: Channel.h:92
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Channel.cpp:295
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Channel.cpp:1245
void setNDFilter(ome::compat::shared_ptr< double > &ndFilter)
Set the NDFilter property.
Definition: Channel.cpp:768
void setFluor(ome::compat::shared_ptr< std::string > &fluor)
Set the Fluor property.
Definition: Channel.cpp:726
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Channel.cpp:1003
void setContrastMethod(ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > &contrastMethod)
Set the ContrastMethod property.
Definition: Channel.cpp:663
void setEmissionWavelength(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &emissionWavelength)
Set the EmissionWavelength property.
Definition: Channel.cpp:789
void setLightPath(ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath)
Set the LightPath property.
Definition: Channel.cpp:976
Channel & operator=(const Channel &)
Assignment operator (deleted).
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: Channel.cpp:1010
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Channel.cpp:930
Open Microscopy Environment C++ implementation.
const std::string & elementName() const
Get the element name of this model object.
Definition: Channel.cpp:288
ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > getAcquisitionMode()
Get the AcquisitionMode property.
Definition: Channel.cpp:607
Private implementation details of Channel model object.
Definition: Channel.cpp:94
void setPinholeSize(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &pinholeSize)
Set the PinholeSize property.
Definition: Channel.cpp:579
ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > getLightSourceSettings()
Get the LightSourceSettings property.
Definition: Channel.cpp:831
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Channel.cpp:600
ome::compat::shared_ptr< double > getNDFilter()
Get the NDFilter property.
Definition: Channel.cpp:754
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: Channel.cpp:914
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: Channel.cpp:920
ome::compat::shared_ptr< ome::xml::model::enums::IlluminationType > getIlluminationType()
Get the IlluminationType property.
Definition: Channel.cpp:691
ome::compat::shared_ptr< ome::xml::model::DetectorSettings > getDetectorSettings()
Get the DetectorSettings property.
Definition: Channel.cpp:852
void setLightSourceSettings(ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Set the LightSourceSettings property.
Definition: Channel.cpp:845
A quantity of a defined unit.
Definition: Quantity.h:57
ome::compat::shared_ptr< int32_t > getPockelCellSetting()
Get the PockelCellSetting property.
Definition: Channel.cpp:733
ome::compat::shared_ptr< ome::xml::model::LightPath > getLightPath()
Get the LightPath property.
Definition: Channel.cpp:962
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: Channel.cpp:523
void setPockelCellSetting(ome::compat::shared_ptr< int32_t > &pockelCellSetting)
Set the PockelCellSetting property.
Definition: Channel.cpp:747
void unlinkFilterSet(ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Unlink FilterSet.
Definition: Channel.cpp:892
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getEmissionWavelength()
Get the EmissionWavelength property.
Definition: Channel.cpp:775
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Channel.cpp:902
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Channel.cpp:997
void setID(const std::string &id)
Set the ID property.
Definition: Channel.cpp:803
void setIlluminationType(ome::compat::shared_ptr< ome::xml::model::enums::IlluminationType > &illuminationType)
Set the IlluminationType property.
Definition: Channel.cpp:705
static ome::compat::shared_ptr< Channel > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Channel model object from DOM element.
Definition: Channel.cpp:279
ome::compat::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Channel.cpp:628
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPinholeSize()
Get the PinholeSize property.
Definition: Channel.cpp:565
ome::compat::weak_ptr< ome::xml::model::FilterSet > getLinkedFilterSet()
Get linked FilterSet.
Definition: Channel.cpp:873
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Channel.cpp:944
void setAcquisitionMode(ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > &acquisitionMode)
Set the AcquisitionMode property.
Definition: Channel.cpp:621