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> 60 #include <ome/common/xml/dom/NodeList.h> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Plate.h> 65 #include <ome/xml/model/Reagent.h> 66 #include <ome/xml/model/detail/OMEModelObject.h> 67 #include <ome/xml/model/primitives/Color.h> 68 #include <ome/xml/model/primitives/NonNegativeInteger.h> 90 ome::compat::shared_ptr<Impl>
impl;
121 static ome::compat::shared_ptr< Well>
151 link (ome::compat::shared_ptr<Reference>& reference,
152 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
159 ome::compat::shared_ptr<std::string>
167 const ome::compat::shared_ptr<std::string>
199 ome::compat::shared_ptr<std::string>
207 const ome::compat::shared_ptr<std::string>
223 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
231 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
240 setColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& color);
247 ome::compat::shared_ptr<std::string>
255 const ome::compat::shared_ptr<std::string>
264 setType (ome::compat::shared_ptr<std::string>& type);
280 setID (
const std::string&
id);
303 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type
312 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
321 const std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
331 ome::compat::shared_ptr<ome::xml::model::WellSample>&
332 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index);
341 const ome::compat::shared_ptr<ome::xml::model::WellSample>&
342 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index)
const;
352 setWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index,
353 ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
364 addWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
376 removeWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
384 ome::compat::weak_ptr<ome::xml::model::Reagent>
393 const ome::compat::weak_ptr<ome::xml::model::Reagent>
402 linkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
414 unlinkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
439 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
452 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
454 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
467 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
485 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
492 ome::compat::weak_ptr<ome::xml::model::Plate>
500 const ome::compat::weak_ptr<ome::xml::model::Plate>
509 setPlate (ome::compat::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
532 #endif // OME_XML_MODEL_WELL_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getID() const
Get the ID property.
Definition: Well.cpp:491
std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type sizeOfWellSampleList() const
Get size of linked WellSample list.
Definition: Well.cpp:519
void setExternalDescription(ome::compat::shared_ptr< std::string > &externalDescription)
Set the ExternalDescription property.
Definition: Well.cpp:442
std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > > & getWellSampleList()
Get the WellSample list.
Definition: Well.cpp:525
ome::compat::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Well.cpp:393
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: Well.cpp:624
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Well.cpp:686
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Well.cpp:606
ome::compat::weak_ptr< ome::xml::model::Reagent > getLinkedReagent()
Get linked Reagent.
Definition: Well.cpp:577
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: Well.cpp:618
ome::compat::shared_ptr< ome::xml::model::WellSample > & getWellSample(std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type index)
Get WellSample.
Definition: Well.cpp:537
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
ome::compat::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Well.cpp:449
void setRow(const ome::xml::model::primitives::NonNegativeInteger &row)
Set the Row property.
Definition: Well.cpp:512
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 setWellSample(std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type index, ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Set WellSample.
Definition: Well.cpp:549
Well model object.
Definition: Well.h:85
static ome::compat::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
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Well.cpp:839
virtual ~Well()
Destructor.
Definition: Well.cpp:204
void setType(ome::compat::shared_ptr< std::string > &type)
Set the Type property.
Definition: Well.cpp:484
const ome::xml::model::primitives::NonNegativeInteger & getColumn() const
Get the Column property.
Definition: Well.cpp:414
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: Well.cpp:351
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Well.h:88
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Well.cpp:634
Open Microscopy Environment C++ implementation.
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Well.cpp:648
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 addWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Add WellSample.
Definition: Well.cpp:558
void setID(const std::string &id)
Set the ID property.
Definition: Well.cpp:498
void setExternalIdentifier(ome::compat::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Well.cpp:407
ome::compat::shared_ptr< std::string > getExternalDescription()
Get the ExternalDescription property.
Definition: Well.cpp:428
void unlinkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Unlink Reagent.
Definition: Well.cpp:596
void setColumn(const ome::xml::model::primitives::NonNegativeInteger &column)
Set the Column property.
Definition: Well.cpp:421
ome::compat::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: Well.cpp:666
void removeWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Remove WellSample.
Definition: Well.cpp:566
void linkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Link Reagent.
Definition: Well.cpp:590
Private implementation details of Well model object.
Definition: Well.cpp:80
Well & operator=(const Well &)
Assignment operator (deleted).
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Well.cpp:612
ome::compat::shared_ptr< std::string > getType()
Get the Type property.
Definition: Well.cpp:470
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: Well.cpp:693
void setColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Well.cpp:463
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:233
Well()
Default constructor.
Definition: Well.cpp:189
const ome::xml::model::primitives::NonNegativeInteger & getRow() const
Get the Row property.
Definition: Well.cpp:505
void setPlate(ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: Well.cpp:680
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119