46 #ifndef OME_XML_MODEL_EXPERIMENT_H 47 #define OME_XML_MODEL_EXPERIMENT_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/Experimenter.h> 64 #include <ome/xml/model/detail/OMEModelObject.h> 65 #include <ome/xml/model/enums/ExperimentType.h> 76 class MicrobeamManipulation;
87 std::shared_ptr<Impl>
impl;
118 static std::shared_ptr<Experiment>
148 link (std::shared_ptr<Reference>& reference,
149 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
156 std::shared_ptr<ome::xml::model::enums::ExperimentType>
164 const std::shared_ptr<ome::xml::model::enums::ExperimentType>
173 setType (std::shared_ptr<ome::xml::model::enums::ExperimentType>& type);
189 setID (
const std::string&
id);
196 std::shared_ptr<std::string>
204 const std::shared_ptr<std::string>
221 std::weak_ptr<ome::xml::model::Experimenter>
230 const std::weak_ptr<ome::xml::model::Experimenter>
239 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
258 std::vector<std::shared_ptr<ome::xml::model::MicrobeamManipulation>>::size_type
267 std::vector<std::shared_ptr<ome::xml::model::MicrobeamManipulation>>&
276 const std::vector<std::shared_ptr<ome::xml::model::MicrobeamManipulation>>&
286 std::shared_ptr<ome::xml::model::MicrobeamManipulation>&
296 const std::shared_ptr<ome::xml::model::MicrobeamManipulation>&
297 getMicrobeamManipulation (std::vector<std::shared_ptr<ome::xml::model::MicrobeamManipulation>>::size_type index)
const;
308 std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
356 const std::weak_ptr<ome::xml::model::Image>&
369 const std::weak_ptr<ome::xml::model::Image>&
371 const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
384 linkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
402 unlinkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
420 #endif // OME_XML_MODEL_EXPERIMENT_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
std::vector< std::shared_ptr< ome::xml::model::MicrobeamManipulation > > & getMicrobeamManipulationList()
Get the MicrobeamManipulation list.
Definition: Experiment.cpp:384
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Experiment.cpp:342
std::shared_ptr< ome::xml::model::enums::ExperimentType > getType()
Get the Type property.
Definition: Experiment.cpp:293
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: Experiment.cpp:197
const std::string & getID() const
Get the ID property.
Definition: Experiment.cpp:314
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Experiment.cpp:349
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: Experiment.cpp:267
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Experiment.cpp:568
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::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: Experiment.cpp:454
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void addMicrobeamManipulation(std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Add MicrobeamManipulation.
Definition: Experiment.cpp:417
Experiment model object.
Definition: Experiment.h:82
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Experiment.cpp:464
void setID(const std::string &id)
Set the ID property.
Definition: Experiment.cpp:321
void setType(std::shared_ptr< ome::xml::model::enums::ExperimentType > &type)
Set the Type property.
Definition: Experiment.cpp:307
Open Microscopy Environment C++ implementation.
Private implementation details of Experiment model object.
Definition: Experiment.cpp:81
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: Experiment.cpp:448
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Experiment.cpp:368
void setMicrobeamManipulation(std::vector< std::shared_ptr< ome::xml::model::MicrobeamManipulation >>::size_type index, std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Set MicrobeamManipulation.
Definition: Experiment.cpp:408
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Experiment.cpp:477
Experiment & operator=(const Experiment &)
Assignment operator (deleted).
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Experiment.cpp:328
Experiment()
Default constructor.
Definition: Experiment.cpp:155
static std::shared_ptr< Experiment > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Experiment model object from DOM element.
Definition: Experiment.cpp:175
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Experiment.cpp:191
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Experiment.cpp:436
virtual ~Experiment()
Destructor.
Definition: Experiment.cpp:170
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Experiment.h:85
void removeMicrobeamManipulation(std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Remove MicrobeamManipulation.
Definition: Experiment.cpp:425
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Experiment.cpp:442
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Experiment.cpp:362
std::vector< std::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type sizeOfMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Experiment.cpp:378
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: Experiment.cpp:493
std::shared_ptr< ome::xml::model::MicrobeamManipulation > & getMicrobeamManipulation(std::vector< std::shared_ptr< ome::xml::model::MicrobeamManipulation >>::size_type index)
Get MicrobeamManipulation.
Definition: Experiment.cpp:396
const std::string & elementName() const
Get the element name of this model object.
Definition: Experiment.cpp:184