46 #ifndef OME_XML_MODEL_WELL_H 47 #define OME_XML_MODEL_WELL_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/Plate.h> 64 #include <ome/xml/model/Reagent.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 66 #include <ome/xml/model/primitives/Color.h> 67 #include <ome/xml/model/primitives/NonNegativeInteger.h> 89 std::shared_ptr<Impl>
impl;
120 static std::shared_ptr<Well>
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>
198 std::shared_ptr<std::string>
206 const std::shared_ptr<std::string>
222 std::shared_ptr<ome::xml::model::primitives::Color>
230 const std::shared_ptr<ome::xml::model::primitives::Color>
239 setColor (std::shared_ptr<ome::xml::model::primitives::Color>& color);
246 std::shared_ptr<std::string>
254 const std::shared_ptr<std::string>
263 setType (std::shared_ptr<std::string>& type);
279 setID (
const std::string&
id);
302 std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type
311 std::vector<std::shared_ptr<ome::xml::model::WellSample>>&
320 const std::vector<std::shared_ptr<ome::xml::model::WellSample>>&
330 std::shared_ptr<ome::xml::model::WellSample>&
331 getWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index);
340 const std::shared_ptr<ome::xml::model::WellSample>&
341 getWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index)
const;
351 setWellSample (std::vector<std::shared_ptr<ome::xml::model::WellSample>>::size_type index,
352 std::shared_ptr<ome::xml::model::WellSample>& wellSample);
363 addWellSample (std::shared_ptr<ome::xml::model::WellSample>& wellSample);
375 removeWellSample (std::shared_ptr<ome::xml::model::WellSample>& wellSample);
383 std::weak_ptr<ome::xml::model::Reagent>
392 const std::weak_ptr<ome::xml::model::Reagent>
401 linkReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
413 unlinkReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
438 const std::weak_ptr<ome::xml::model::Annotation>&
451 const std::weak_ptr<ome::xml::model::Annotation>&
453 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
466 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
484 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
491 std::weak_ptr<ome::xml::model::Plate>
499 const std::weak_ptr<ome::xml::model::Plate>
508 setPlate (std::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
526 #endif // OME_XML_MODEL_WELL_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
const std::string & getID() const
Get the ID property.
Definition: Well.cpp:483
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Well.cpp:604
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::string & elementName() const
Get the element name of this model object.
Definition: Well.cpp:218
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void setRow(const ome::xml::model::primitives::NonNegativeInteger &row)
Set the Row property.
Definition: Well.cpp:504
static std::shared_ptr< Well > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Well model object from DOM element.
Definition: Well.cpp:209
void setWellSample(std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index, std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Set WellSample.
Definition: Well.cpp:541
void setType(std::shared_ptr< std::string > &type)
Set the Type property.
Definition: Well.cpp:476
std::vector< std::shared_ptr< ome::xml::model::WellSample > >::size_type sizeOfWellSampleList() const
Get size of linked WellSample list.
Definition: Well.cpp:511
Well model object.
Definition: Well.h:84
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: Well.cpp:678
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Well.cpp:803
virtual ~Well()
Destructor.
Definition: Well.cpp:204
std::vector< std::shared_ptr< ome::xml::model::WellSample > > & getWellSampleList()
Get the WellSample list.
Definition: Well.cpp:517
const ome::xml::model::primitives::NonNegativeInteger & getColumn() const
Get the Column property.
Definition: Well.cpp:406
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
void setExternalIdentifier(std::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Well.cpp:399
std::weak_ptr< ome::xml::model::Reagent > getLinkedReagent()
Get linked Reagent.
Definition: Well.cpp:569
void unlinkReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Unlink Reagent.
Definition: Well.cpp:588
Open Microscopy Environment C++ implementation.
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Well.cpp:225
void setID(const std::string &id)
Set the ID property.
Definition: Well.cpp:490
std::shared_ptr< ome::xml::model::WellSample > & getWellSample(std::vector< std::shared_ptr< ome::xml::model::WellSample >>::size_type index)
Get WellSample.
Definition: Well.cpp:529
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Well.cpp:640
std::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Well.cpp:385
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: Well.cpp:610
void removeWellSample(std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Remove WellSample.
Definition: Well.cpp:558
void setColumn(const ome::xml::model::primitives::NonNegativeInteger &column)
Set the Column property.
Definition: Well.cpp:413
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: Well.cpp:616
std::shared_ptr< std::string > getType()
Get the Type property.
Definition: Well.cpp:462
void linkReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Link Reagent.
Definition: Well.cpp:582
std::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Well.cpp:441
Private implementation details of Well model object.
Definition: Well.cpp:80
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Well.cpp:598
void setColor(std::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Well.cpp:455
std::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: Well.cpp:658
Well & operator=(const Well &)
Assignment operator (deleted).
void setExternalDescription(std::shared_ptr< std::string > &externalDescription)
Set the ExternalDescription property.
Definition: Well.cpp:434
void addWellSample(std::shared_ptr< ome::xml::model::WellSample > &wellSample)
Add WellSample.
Definition: Well.cpp:550
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Well.cpp:626
std::shared_ptr< std::string > getExternalDescription()
Get the ExternalDescription property.
Definition: Well.cpp:420
void setPlate(std::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: Well.cpp:672
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: Well.cpp:343
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: Well.cpp:231
Well()
Default constructor.
Definition: Well.cpp:189
const ome::xml::model::primitives::NonNegativeInteger & getRow() const
Get the Row property.
Definition: Well.cpp:497
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:118
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Well.h:87