46 #ifndef OME_XML_MODEL_REAGENT_H 47 #define OME_XML_MODEL_REAGENT_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/Screen.h> 64 #include <ome/xml/model/detail/OMEModelObject.h> 86 std::shared_ptr<Impl>
impl;
117 static std::shared_ptr<Reagent>
147 link (std::shared_ptr<Reference>& reference,
148 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
155 std::shared_ptr<std::string>
163 const std::shared_ptr<std::string>
188 setID (
const std::string&
id);
195 std::shared_ptr<std::string>
203 const std::shared_ptr<std::string>
212 setName (std::shared_ptr<std::string>& name);
219 std::shared_ptr<std::string>
227 const std::shared_ptr<std::string>
261 const std::weak_ptr<ome::xml::model::Annotation>&
274 const std::weak_ptr<ome::xml::model::Annotation>&
276 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
289 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
307 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
314 std::weak_ptr<ome::xml::model::Screen>
322 const std::weak_ptr<ome::xml::model::Screen>
331 setScreen (std::weak_ptr<ome::xml::model::Screen>& screen_BackReference);
356 const std::weak_ptr<ome::xml::model::Well>&
369 const std::weak_ptr<ome::xml::model::Well>&
371 const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
384 linkWell (
const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
402 unlinkWell (
const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
420 #endif // OME_XML_MODEL_REAGENT_H 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: Reagent.cpp:394
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Reagent.cpp:376
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Reagent.cpp:348
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Reagent.cpp:590
std::shared_ptr< std::string > getReagentIdentifier()
Get the ReagentIdentifier property.
Definition: Reagent.cpp:299
const std::weak_ptr< ome::xml::model::Well > & getLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index) const
Get linked Well.
Definition: Reagent.cpp:469
void setReagentIdentifier(std::shared_ptr< std::string > &reagentIdentifier)
Set the ReagentIdentifier property.
Definition: Reagent.cpp:313
std::weak_ptr< ome::xml::model::Screen > getScreen()
Get the Screen property.
Definition: Reagent.cpp:436
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
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
static std::shared_ptr< Reagent > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Reagent model object from DOM element.
Definition: Reagent.cpp:175
bool unlinkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Reagent.cpp:498
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Reagent.cpp:404
void setID(const std::string &id)
Set the ID property.
Definition: Reagent.cpp:327
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Reagent.cpp:334
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Reagent.cpp:191
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
Reagent model object.
Definition: Reagent.h:81
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: Reagent.cpp:514
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type sizeOfLinkedWellList() const
Get size of linked Well list.
Definition: Reagent.cpp:457
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Reagent.cpp:355
Reagent & operator=(const Reagent &)
Assignment operator (deleted).
const std::string & getID() const
Get the ID property.
Definition: Reagent.cpp:320
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: Reagent.cpp:388
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: Reagent.cpp:268
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type getLinkedWellList() const
Get the linked Well list.
Definition: Reagent.cpp:463
virtual ~Reagent()
Destructor.
Definition: Reagent.cpp:170
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Reagent.cpp:418
bool linkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Reagent.cpp:485
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: Reagent.cpp:197
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Reagent.cpp:382
const std::weak_ptr< ome::xml::model::Well > & setLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Set linked Well.
Definition: Reagent.cpp:475
const std::string & elementName() const
Get the element name of this model object.
Definition: Reagent.cpp:184
void setScreen(std::weak_ptr< ome::xml::model::Screen > &screen_BackReference)
Set the Screen property.
Definition: Reagent.cpp:450
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Reagent.h:84
Private implementation details of Reagent model object.
Definition: Reagent.cpp:74
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Reagent.cpp:369
Reagent()
Default constructor.
Definition: Reagent.cpp:155