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> 60 #include <ome/common/xml/dom/NodeList.h> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Experimenter.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 66 #include <ome/xml/model/enums/ExperimentType.h> 77 class MicrobeamManipulation;
88 ome::compat::shared_ptr<Impl>
impl;
119 static ome::compat::shared_ptr< Experiment>
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
157 ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
165 const ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
174 setType (ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>& type);
190 setID (
const std::string&
id);
197 ome::compat::shared_ptr<std::string>
205 const ome::compat::shared_ptr<std::string>
214 setDescription (ome::compat::shared_ptr<std::string>& description);
222 ome::compat::weak_ptr<ome::xml::model::Experimenter>
231 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
240 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
252 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
259 std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type
268 std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
277 const std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
287 ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
288 getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index);
297 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
298 getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index)
const;
308 setMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index,
309 ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
357 const ome::compat::weak_ptr<ome::xml::model::Image>&
370 const ome::compat::weak_ptr<ome::xml::model::Image>&
372 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
385 linkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
403 unlinkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
426 #endif // OME_XML_MODEL_EXPERIMENT_H ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > & getMicrobeamManipulation(std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type index)
Get MicrobeamManipulation.
Definition: Experiment.cpp:402
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void addMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Add MicrobeamManipulation.
Definition: Experiment.cpp:423
const ome::compat::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: Experiment.cpp:460
const ome::compat::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Experiment.cpp:454
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:199
const std::string & getID() const
Get the ID property.
Definition: Experiment.cpp:320
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Experiment.cpp:442
static ome::compat::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
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Experiment.cpp:591
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Experiment.cpp:448
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
void setType(ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > &type)
Set the Type property.
Definition: Experiment.cpp:313
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Experiment.cpp:368
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: Experiment.cpp:273
ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > getType()
Get the Type property.
Definition: Experiment.cpp:299
void removeMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Remove MicrobeamManipulation.
Definition: Experiment.cpp:431
Experiment model object.
Definition: Experiment.h:83
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type sizeOfMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Experiment.cpp:384
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Experiment.cpp:334
void setID(const std::string &id)
Set the ID property.
Definition: Experiment.cpp:327
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Experiment.h:86
Open Microscopy Environment C++ implementation.
Private implementation details of Experiment model object.
Definition: Experiment.cpp:81
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Experiment.cpp:483
Experiment & operator=(const Experiment &)
Assignment operator (deleted).
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Experiment.cpp:499
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Experiment.cpp:374
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Experiment.cpp:470
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Experiment.cpp:348
Experiment()
Default constructor.
Definition: Experiment.cpp:155
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Experiment.cpp:355
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
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: Experiment.cpp:506
virtual ~Experiment()
Destructor.
Definition: Experiment.cpp:170
void setMicrobeamManipulation(std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Set MicrobeamManipulation.
Definition: Experiment.cpp:414
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > > & getMicrobeamManipulationList()
Get the MicrobeamManipulation list.
Definition: Experiment.cpp:390
const std::string & elementName() const
Get the element name of this model object.
Definition: Experiment.cpp:184