46 #ifndef OME_XML_MODEL_MICROBEAMMANIPULATION_H 47 #define OME_XML_MODEL_MICROBEAMMANIPULATION_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/Experiment.h> 64 #include <ome/xml/model/Experimenter.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 66 #include <ome/xml/model/enums/MicrobeamManipulationType.h> 77 class LightSourceSettings;
89 std::shared_ptr<Impl>
impl;
120 static std::shared_ptr<MicrobeamManipulation>
150 link (std::shared_ptr<Reference>& reference,
151 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
158 std::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>
166 const std::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>
175 setType (std::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>& type);
191 setID (
const std::string&
id);
198 std::shared_ptr<std::string>
206 const std::shared_ptr<std::string>
240 const std::weak_ptr<ome::xml::model::ROI>&
253 const std::weak_ptr<ome::xml::model::ROI>&
255 const std::shared_ptr<ome::xml::model::ROI>& roi);
268 linkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
286 unlinkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
294 std::weak_ptr<ome::xml::model::Experimenter>
303 const std::weak_ptr<ome::xml::model::Experimenter>
312 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
331 std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>::size_type
340 std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>&
349 const std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>&
359 std::shared_ptr<ome::xml::model::LightSourceSettings>&
360 getLightSourceSettings (std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>::size_type index);
369 const std::shared_ptr<ome::xml::model::LightSourceSettings>&
370 getLightSourceSettings (std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>::size_type index)
const;
380 setLightSourceSettings (std::vector<std::shared_ptr<ome::xml::model::LightSourceSettings>>::size_type index,
381 std::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
429 const std::weak_ptr<ome::xml::model::Image>&
442 const std::weak_ptr<ome::xml::model::Image>&
444 const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
457 linkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
475 unlinkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
482 std::weak_ptr<ome::xml::model::Experiment>
490 const std::weak_ptr<ome::xml::model::Experiment>
499 setExperiment (std::weak_ptr<ome::xml::model::Experiment>& experiment_BackReference);
517 #endif // OME_XML_MODEL_MICROBEAMMANIPULATION_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: MicrobeamManipulation.cpp:430
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: MicrobeamManipulation.cpp:541
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: MicrobeamManipulation.cpp:576
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: MicrobeamManipulation.cpp:290
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: MicrobeamManipulation.cpp:467
void setType(std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > &type)
Set the Type property.
Definition: MicrobeamManipulation.cpp:346
const std::string & getID() const
Get the ID property.
Definition: MicrobeamManipulation.cpp:353
const std::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ROI > &roi)
Set linked ROI.
Definition: MicrobeamManipulation.cpp:406
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
std::weak_ptr< ome::xml::model::Experiment > getExperiment()
Get the Experiment property.
Definition: MicrobeamManipulation.cpp:593
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: MicrobeamManipulation.cpp:416
void setExperiment(std::weak_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Set the Experiment property.
Definition: MicrobeamManipulation.cpp:607
void setLightSourceSettings(std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type index, std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Set LightSourceSettings.
Definition: MicrobeamManipulation.cpp:507
virtual ~MicrobeamManipulation()
Destructor.
Definition: MicrobeamManipulation.cpp:183
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: MicrobeamManipulation.cpp:388
std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > getType()
Get the Type property.
Definition: MicrobeamManipulation.cpp:332
const std::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: MicrobeamManipulation.cpp:553
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: MicrobeamManipulation.cpp:448
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: MicrobeamManipulation.cpp:367
Open Microscopy Environment C++ implementation.
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: MicrobeamManipulation.cpp:613
const std::string & elementName() const
Get the element name of this model object.
Definition: MicrobeamManipulation.cpp:197
MicrobeamManipulation()
Default constructor.
Definition: MicrobeamManipulation.cpp:168
std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type sizeOfLightSourceSettingsList() const
Get size of linked LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:477
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MicrobeamManipulation.cpp:204
MicrobeamManipulation model object.
Definition: MicrobeamManipulation.h:84
static std::shared_ptr< MicrobeamManipulation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a MicrobeamManipulation model object from DOM element.
Definition: MicrobeamManipulation.cpp:188
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: MicrobeamManipulation.cpp:535
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: MicrobeamManipulation.cpp:381
std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > > & getLightSourceSettingsList()
Get the LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:483
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: MicrobeamManipulation.cpp:461
void addLightSourceSettings(std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Add LightSourceSettings.
Definition: MicrobeamManipulation.cpp:516
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: MicrobeamManipulation.cpp:563
Private implementation details of MicrobeamManipulation model object.
Definition: MicrobeamManipulation.cpp:80
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MicrobeamManipulation.cpp:707
std::shared_ptr< ome::xml::model::LightSourceSettings > & getLightSourceSettings(std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type index)
Get LightSourceSettings.
Definition: MicrobeamManipulation.cpp:495
const std::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: MicrobeamManipulation.cpp:547
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: MicrobeamManipulation.cpp:394
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: MicrobeamManipulation.cpp:210
MicrobeamManipulation & operator=(const MicrobeamManipulation &)
Assignment operator (deleted).
void removeLightSourceSettings(std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Remove LightSourceSettings.
Definition: MicrobeamManipulation.cpp:524
std::shared_ptr< Impl > impl
Private implementation details.
Definition: MicrobeamManipulation.h:87
void setID(const std::string &id)
Set the ID property.
Definition: MicrobeamManipulation.cpp:360
const std::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: MicrobeamManipulation.cpp:400