46 #ifndef OME_XML_MODEL_EXPERIMENTER_H 47 #define OME_XML_MODEL_EXPERIMENTER_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/detail/OMEModelObject.h> 76 class ExperimenterGroup;
78 class MicrobeamManipulation;
90 std::shared_ptr<Impl>
impl;
121 static std::shared_ptr<Experimenter>
150 link (std::shared_ptr<Reference>& reference,
151 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
158 std::shared_ptr<std::string>
166 const std::shared_ptr<std::string>
175 setEmail (std::shared_ptr<std::string>& email);
182 std::shared_ptr<std::string>
190 const std::shared_ptr<std::string>
199 setUserName (std::shared_ptr<std::string>& userName);
206 std::shared_ptr<std::string>
214 const std::shared_ptr<std::string>
230 std::shared_ptr<std::string>
238 const std::shared_ptr<std::string>
254 std::shared_ptr<std::string>
262 const std::shared_ptr<std::string>
271 setLastName (std::shared_ptr<std::string>& lastName);
287 setID (
const std::string&
id);
294 std::shared_ptr<std::string>
302 const std::shared_ptr<std::string>
336 const std::weak_ptr<ome::xml::model::Annotation>&
349 const std::weak_ptr<ome::xml::model::Annotation>&
351 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
364 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
382 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
407 const std::weak_ptr<ome::xml::model::Image>&
420 const std::weak_ptr<ome::xml::model::Image>&
422 const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
435 linkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
453 unlinkImage (
const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
478 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
491 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
493 const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
506 linkMicrobeamManipulation (
const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
549 const std::weak_ptr<ome::xml::model::Project>&
562 const std::weak_ptr<ome::xml::model::Project>&
564 const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
577 linkProject (
const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
595 unlinkProject (
const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
620 const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
633 const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
635 const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
648 linkExperimenterGroup (
const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
666 unlinkExperimenterGroup (
const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
691 const std::weak_ptr<ome::xml::model::Dataset>&
704 const std::weak_ptr<ome::xml::model::Dataset>&
706 const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
719 linkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
737 unlinkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
762 const std::weak_ptr<ome::xml::model::Experiment>&
775 const std::weak_ptr<ome::xml::model::Experiment>&
777 const std::shared_ptr<ome::xml::model::Experiment>& experiment_BackReference);
790 linkExperiment (
const std::shared_ptr<ome::xml::model::Experiment>& experiment_BackReference);
808 unlinkExperiment (
const std::shared_ptr<ome::xml::model::Experiment>& experiment_BackReference);
826 #endif // OME_XML_MODEL_EXPERIMENTER_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type getLinkedExperimenterGroupList() const
Get the linked ExperimenterGroup list.
Definition: Experimenter.cpp:757
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Experimenter.cpp:1027
void setID(const std::string &id)
Set the ID property.
Definition: Experimenter.cpp:489
const std::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Set linked Dataset.
Definition: Experimenter.cpp:827
virtual ~Experimenter()
Destructor.
Definition: Experimenter.cpp:227
const std::weak_ptr< ome::xml::model::Experiment > & setLinkedExperiment(OMEModelObject::indexed_container< ome::xml::model::Experiment, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Set linked Experiment.
Definition: Experimenter.cpp:885
OMEModelObject::indexed_container< ome::xml::model::Experiment, std::weak_ptr >::type::size_type sizeOfLinkedExperimentList() const
Get size of linked Experiment list.
Definition: Experimenter.cpp:867
const std::weak_ptr< ome::xml::model::Project > & setLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Set linked Project.
Definition: Experimenter.cpp:711
bool linkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Experimenter.cpp:779
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: Experimenter.cpp:595
const std::weak_ptr< ome::xml::model::Project > & getLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index) const
Get linked Project.
Definition: Experimenter.cpp:705
Experimenter()
Default constructor.
Definition: Experimenter.cpp:212
const std::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Experimenter.cpp:821
bool unlinkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Experimenter.cpp:850
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Experimenter.cpp:605
bool unlinkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Experimenter.cpp:734
void setInstitution(std::shared_ptr< std::string > &institution)
Set the Institution property.
Definition: Experimenter.cpp:510
const std::weak_ptr< ome::xml::model::Experiment > & getLinkedExperiment(OMEModelObject::indexed_container< ome::xml::model::Experiment, std::weak_ptr >::type::size_type index) const
Get linked Experiment.
Definition: Experimenter.cpp:879
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
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Experimenter.cpp:635
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index) const
Get linked ExperimenterGroup.
Definition: Experimenter.cpp:763
std::shared_ptr< std::string > getFirstName()
Get the FirstName property.
Definition: Experimenter.cpp:419
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: Experimenter.cpp:529
bool linkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Experimenter.cpp:721
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Set linked ExperimenterGroup.
Definition: Experimenter.cpp:769
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Experimenter.cpp:559
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Experimenter.cpp:248
void setLastName(std::shared_ptr< std::string > &lastName)
Set the LastName property.
Definition: Experimenter.cpp:475
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Experimenter.cpp:815
bool linkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Experimenter.cpp:837
bool unlinkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Experimenter.cpp:792
Experimenter model object.
Definition: Experimenter.h:85
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
static std::shared_ptr< Experimenter > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Experimenter model object from DOM element.
Definition: Experimenter.cpp:232
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: Experimenter.cpp:535
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Experimenter.cpp:693
Open Microscopy Environment C++ implementation.
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Experimenter.cpp:699
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: Experimenter.cpp:924
void setEmail(std::shared_ptr< std::string > &email)
Set the Email property.
Definition: Experimenter.cpp:391
void setMiddleName(std::shared_ptr< std::string > &middleName)
Set the MiddleName property.
Definition: Experimenter.cpp:454
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Experimenter.cpp:523
std::shared_ptr< std::string > getMiddleName()
Get the MiddleName property.
Definition: Experimenter.cpp:440
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Experimenter.cpp:545
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: Experimenter.cpp:751
bool unlinkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation_BackReference)
Unlink MicrobeamManipulation.
Definition: Experimenter.cpp:676
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Experimenter.cpp:618
const std::string & getID() const
Get the ID property.
Definition: Experimenter.cpp:482
bool linkExperiment(const std::shared_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Link Experiment.
Definition: Experimenter.cpp:895
OMEModelObject::indexed_container< ome::xml::model::Experiment, std::weak_ptr >::type getLinkedExperimentList() const
Get the linked Experiment list.
Definition: Experimenter.cpp:873
std::shared_ptr< std::string > getInstitution()
Get the Institution property.
Definition: Experimenter.cpp:496
void setFirstName(std::shared_ptr< std::string > &firstName)
Set the FirstName property.
Definition: Experimenter.cpp:433
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & getLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index) const
Get linked MicrobeamManipulation.
Definition: Experimenter.cpp:647
bool unlinkExperiment(const std::shared_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Unlink Experiment.
Definition: Experimenter.cpp:908
Private implementation details of Experimenter model object.
Definition: Experimenter.cpp:78
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & setLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation_BackReference)
Set linked MicrobeamManipulation.
Definition: Experimenter.cpp:653
bool linkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation_BackReference)
Link MicrobeamManipulation.
Definition: Experimenter.cpp:663
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: Experimenter.cpp:589
void setUserName(std::shared_ptr< std::string > &userName)
Set the UserName property.
Definition: Experimenter.cpp:412
std::shared_ptr< std::string > getEmail()
Get the Email property.
Definition: Experimenter.cpp:377
std::shared_ptr< std::string > getLastName()
Get the LastName property.
Definition: Experimenter.cpp:461
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Experimenter.cpp:583
virtual SKIP void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Experimenter.cpp:254
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Experimenter.cpp:577
const std::string & elementName() const
Get the element name of this model object.
Definition: Experimenter.cpp:241
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Experimenter.h:88
std::shared_ptr< std::string > getUserName()
Get the UserName property.
Definition: Experimenter.cpp:398
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Experimenter.cpp:809
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Experimenter.cpp:641
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: Experimenter.cpp:346
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Experimenter.cpp:517