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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/DetectorSettings.h> 64 #include <ome/xml/model/FilterSet.h> 65 #include <ome/xml/model/LightPath.h> 66 #include <ome/xml/model/LightSourceSettings.h> 67 #include <ome/xml/model/Pixels.h> 68 #include <ome/xml/model/detail/OMEModelObject.h> 69 #include <ome/xml/model/enums/AcquisitionMode.h> 70 #include <ome/xml/model/enums/ContrastMethod.h> 71 #include <ome/xml/model/enums/IlluminationType.h> 72 #include <ome/xml/model/enums/UnitsLength.h> 73 #include <ome/xml/model/primitives/Color.h> 74 #include <ome/xml/model/primitives/PositiveFloat.h> 75 #include <ome/xml/model/primitives/PositiveInteger.h> 96 std::shared_ptr<Impl>
impl;
127 static std::shared_ptr<Channel>
157 link (std::shared_ptr<Reference>& reference,
158 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
165 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
173 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
189 std::shared_ptr<std::string>
197 const std::shared_ptr<std::string>
206 setName (std::shared_ptr<std::string>& name);
213 std::shared_ptr<ome::xml::model::enums::AcquisitionMode>
221 const std::shared_ptr<ome::xml::model::enums::AcquisitionMode>
230 setAcquisitionMode (std::shared_ptr<ome::xml::model::enums::AcquisitionMode>& acquisitionMode);
237 std::shared_ptr<ome::xml::model::primitives::Color>
245 const std::shared_ptr<ome::xml::model::primitives::Color>
254 setColor (std::shared_ptr<ome::xml::model::primitives::Color>& color);
261 std::shared_ptr<ome::xml::model::enums::ContrastMethod>
269 const std::shared_ptr<ome::xml::model::enums::ContrastMethod>
278 setContrastMethod (std::shared_ptr<ome::xml::model::enums::ContrastMethod>& contrastMethod);
285 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
293 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
309 std::shared_ptr<ome::xml::model::enums::IlluminationType>
317 const std::shared_ptr<ome::xml::model::enums::IlluminationType>
326 setIlluminationType (std::shared_ptr<ome::xml::model::enums::IlluminationType>& illuminationType);
333 std::shared_ptr<std::string>
341 const std::shared_ptr<std::string>
350 setFluor (std::shared_ptr<std::string>& fluor);
357 std::shared_ptr<int32_t>
365 const std::shared_ptr<int32_t>
381 std::shared_ptr<double>
389 const std::shared_ptr<double>
405 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
413 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
438 setID (
const std::string&
id);
445 std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
453 const std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
462 setSamplesPerPixel (std::shared_ptr<ome::xml::model::primitives::PositiveInteger>& samplesPerPixel);
469 std::shared_ptr<ome::xml::model::LightSourceSettings>
477 const std::shared_ptr<ome::xml::model::LightSourceSettings>
493 std::shared_ptr<ome::xml::model::DetectorSettings>
501 const std::shared_ptr<ome::xml::model::DetectorSettings>
510 setDetectorSettings (std::shared_ptr<ome::xml::model::DetectorSettings>& detectorSettings);
518 std::weak_ptr<ome::xml::model::FilterSet>
527 const std::weak_ptr<ome::xml::model::FilterSet>
536 linkFilterSet (std::shared_ptr<ome::xml::model::FilterSet>& filterSet);
548 unlinkFilterSet (std::shared_ptr<ome::xml::model::FilterSet>& filterSet);
573 const std::weak_ptr<ome::xml::model::Annotation>&
586 const std::weak_ptr<ome::xml::model::Annotation>&
588 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
601 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
619 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
626 std::shared_ptr<ome::xml::model::LightPath>
634 const std::shared_ptr<ome::xml::model::LightPath>
643 setLightPath (std::shared_ptr<ome::xml::model::LightPath>& lightPath);
650 std::weak_ptr<ome::xml::model::Pixels>
658 const std::weak_ptr<ome::xml::model::Pixels>
667 setPixels (std::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
685 #endif // OME_XML_MODEL_CHANNEL_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPinholeSize()
Get the PinholeSize property.
Definition: Channel.cpp:559
void setPockelCellSetting(std::shared_ptr< int32_t > &pockelCellSetting)
Set the PockelCellSetting property.
Definition: Channel.cpp:741
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Channel.cpp:924
void setExcitationWavelength(const std::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:678
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Channel.cpp:938
void setAcquisitionMode(std::shared_ptr< ome::xml::model::enums::AcquisitionMode > &acquisitionMode)
Set the AcquisitionMode property.
Definition: Channel.cpp:615
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Channel.h:94
void setPinholeSize(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &pinholeSize)
Set the PinholeSize property.
Definition: Channel.cpp:573
Channel()
Default constructor.
Definition: Channel.cpp:259
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Channel.cpp:580
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:301
void setIlluminationType(std::shared_ptr< ome::xml::model::enums::IlluminationType > &illuminationType)
Set the IlluminationType property.
Definition: Channel.cpp:699
virtual ~Channel()
Destructor.
Definition: Channel.cpp:274
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
const std::string & getID() const
Get the ID property.
Definition: Channel.cpp:790
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
Channel model object.
Definition: Channel.h:91
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: Channel.cpp:908
std::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Channel.cpp:977
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
std::weak_ptr< ome::xml::model::FilterSet > getLinkedFilterSet()
Get linked FilterSet.
Definition: Channel.cpp:867
void setLightPath(std::shared_ptr< ome::xml::model::LightPath > &lightPath)
Set the LightPath property.
Definition: Channel.cpp:970
void setSamplesPerPixel(std::shared_ptr< ome::xml::model::primitives::PositiveInteger > &samplesPerPixel)
Set the SamplesPerPixel property.
Definition: Channel.cpp:818
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Channel.cpp:1199
std::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSamplesPerPixel()
Get the SamplesPerPixel property.
Definition: Channel.cpp:804
std::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:769
Channel & operator=(const Channel &)
Assignment operator (deleted).
void linkFilterSet(std::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Link FilterSet.
Definition: Channel.cpp:880
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: Channel.cpp:997
std::shared_ptr< ome::xml::model::enums::AcquisitionMode > getAcquisitionMode()
Get the AcquisitionMode property.
Definition: Channel.cpp:601
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
std::shared_ptr< int32_t > getPockelCellSetting()
Get the PockelCellSetting property.
Definition: Channel.cpp:727
Open Microscopy Environment C++ implementation.
static std::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
std::shared_ptr< ome::xml::model::DetectorSettings > getDetectorSettings()
Get the DetectorSettings property.
Definition: Channel.cpp:846
const std::string & elementName() const
Get the element name of this model object.
Definition: Channel.cpp:288
std::shared_ptr< ome::xml::model::LightPath > getLightPath()
Get the LightPath property.
Definition: Channel.cpp:956
void unlinkFilterSet(std::shared_ptr< ome::xml::model::FilterSet > &filterSet)
Unlink FilterSet.
Definition: Channel.cpp:886
void setEmissionWavelength(const std::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:783
Private implementation details of Channel model object.
Definition: Channel.cpp:94
void setColor(std::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Channel.cpp:636
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: Channel.cpp:914
void setDetectorSettings(std::shared_ptr< ome::xml::model::DetectorSettings > &detectorSettings)
Set the DetectorSettings property.
Definition: Channel.cpp:860
void setFluor(std::shared_ptr< std::string > &fluor)
Set the Fluor property.
Definition: Channel.cpp:720
std::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:664
void setLightSourceSettings(std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Set the LightSourceSettings property.
Definition: Channel.cpp:839
void setPixels(std::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Channel.cpp:991
std::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Channel.cpp:622
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: Channel.cpp:517
std::shared_ptr< std::string > getFluor()
Get the Fluor property.
Definition: Channel.cpp:706
A quantity of a defined unit.
Definition: Quantity.h:57
std::shared_ptr< ome::xml::model::LightSourceSettings > getLightSourceSettings()
Get the LightSourceSettings property.
Definition: Channel.cpp:825
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Channel.cpp:594
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Channel.cpp:896
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Channel.cpp:902
std::shared_ptr< ome::xml::model::enums::ContrastMethod > getContrastMethod()
Get the ContrastMethod property.
Definition: Channel.cpp:643
void setID(const std::string &id)
Set the ID property.
Definition: Channel.cpp:797
void setNDFilter(std::shared_ptr< double > &ndFilter)
Set the NDFilter property.
Definition: Channel.cpp:762
std::shared_ptr< double > getNDFilter()
Get the NDFilter property.
Definition: Channel.cpp:748
void setContrastMethod(std::shared_ptr< ome::xml::model::enums::ContrastMethod > &contrastMethod)
Set the ContrastMethod property.
Definition: Channel.cpp:657
std::shared_ptr< ome::xml::model::enums::IlluminationType > getIlluminationType()
Get the IlluminationType property.
Definition: Channel.cpp:685