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> 60 #include <ome/common/xml/dom/NodeList.h> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Screen.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 87 ome::compat::shared_ptr<Impl>
impl;
118 static ome::compat::shared_ptr< Reagent>
148 link (ome::compat::shared_ptr<Reference>& reference,
149 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
156 ome::compat::shared_ptr<std::string>
164 const ome::compat::shared_ptr<std::string>
189 setID (
const std::string&
id);
196 ome::compat::shared_ptr<std::string>
204 const ome::compat::shared_ptr<std::string>
213 setName (ome::compat::shared_ptr<std::string>& name);
220 ome::compat::shared_ptr<std::string>
228 const ome::compat::shared_ptr<std::string>
237 setDescription (ome::compat::shared_ptr<std::string>& description);
262 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
275 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
277 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
290 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
308 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
315 ome::compat::weak_ptr<ome::xml::model::Screen>
323 const ome::compat::weak_ptr<ome::xml::model::Screen>
332 setScreen (ome::compat::weak_ptr<ome::xml::model::Screen>& screen_BackReference);
357 const ome::compat::weak_ptr<ome::xml::model::Well>&
370 const ome::compat::weak_ptr<ome::xml::model::Well>&
372 const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
385 linkWell (
const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
403 unlinkWell (
const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
426 #endif // OME_XML_MODEL_REAGENT_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool linkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Reagent.cpp:493
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellList() const
Get size of linked Well list.
Definition: Reagent.cpp:465
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: Reagent.cpp:529
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type getLinkedWellList() const
Get the linked Well list.
Definition: Reagent.cpp:471
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Reagent.cpp:356
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Reagent.cpp:396
ome::compat::shared_ptr< std::string > getReagentIdentifier()
Get the ReagentIdentifier property.
Definition: Reagent.cpp:307
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Reagent.cpp:363
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Reagent.cpp:426
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Reagent.cpp:402
ome::compat::weak_ptr< ome::xml::model::Screen > getScreen()
Get the Screen property.
Definition: Reagent.cpp:444
const ome::compat::weak_ptr< ome::xml::model::Well > & getLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index) const
Get linked Well.
Definition: Reagent.cpp:477
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
bool unlinkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Reagent.cpp:506
const ome::compat::weak_ptr< ome::xml::model::Well > & setLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Set linked Well.
Definition: Reagent.cpp:483
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Reagent.cpp:384
void setReagentIdentifier(ome::compat::shared_ptr< std::string > &reagentIdentifier)
Set the ReagentIdentifier property.
Definition: Reagent.cpp:321
void setID(const std::string &id)
Set the ID property.
Definition: Reagent.cpp:335
void setScreen(ome::compat::weak_ptr< ome::xml::model::Screen > &screen_BackReference)
Set the Screen property.
Definition: Reagent.cpp:458
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
Reagent model object.
Definition: Reagent.h:82
Open Microscopy Environment C++ implementation.
const std::string & elementName() const
Get the element name of this model object.
Definition: Reagent.cpp:188
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Reagent.cpp:377
Reagent & operator=(const Reagent &)
Assignment operator (deleted).
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Reagent.cpp:412
const std::string & getID() const
Get the ID property.
Definition: Reagent.cpp:328
virtual ~Reagent()
Destructor.
Definition: Reagent.cpp:174
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:203
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Reagent.cpp:522
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: Reagent.cpp:276
static ome::compat::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:179
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Reagent.cpp:618
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Reagent.h:85
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Reagent.cpp:390
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Reagent.cpp:195
Private implementation details of Reagent model object.
Definition: Reagent.cpp:74
Reagent()
Default constructor.
Definition: Reagent.cpp:155
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Reagent.cpp:342