46 #ifndef OME_XML_MODEL_WELLSAMPLE_H 47 #define OME_XML_MODEL_WELLSAMPLE_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/Image.h> 65 #include <ome/xml/model/Well.h> 66 #include <ome/xml/model/detail/OMEModelObject.h> 67 #include <ome/xml/model/enums/UnitsLength.h> 68 #include <ome/xml/model/primitives/NonNegativeInteger.h> 69 #include <ome/xml/model/primitives/Timestamp.h> 80 class PlateAcquisition;
90 ome::compat::shared_ptr<Impl>
impl;
121 static ome::compat::shared_ptr< WellSample>
151 link (ome::compat::shared_ptr<Reference>& reference,
152 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
175 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
183 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
199 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
207 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
223 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
231 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
240 setTimepoint (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& timepoint);
256 setID (
const std::string&
id);
264 ome::compat::weak_ptr<ome::xml::model::Image>
273 const ome::compat::weak_ptr<ome::xml::model::Image>
282 linkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
294 unlinkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
319 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
332 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
334 const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
347 linkPlateAcquisition (
const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
365 unlinkPlateAcquisition (
const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
372 ome::compat::weak_ptr<ome::xml::model::Well>
380 const ome::compat::weak_ptr<ome::xml::model::Well>
389 setWell (ome::compat::weak_ptr<ome::xml::model::Well>& well_BackReference);
412 #endif // OME_XML_MODEL_WELLSAMPLE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setIndex(const ome::xml::model::primitives::NonNegativeInteger &index)
Set the Index property.
Definition: WellSample.cpp:332
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: WellSample.cpp:473
void setID(const std::string &id)
Set the ID property.
Definition: WellSample.cpp:409
ome::compat::weak_ptr< ome::xml::model::Well > getWell()
Get the Well property.
Definition: WellSample.cpp:503
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: WellSample.cpp:523
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: WellSample.cpp:211
ome::compat::weak_ptr< ome::xml::model::Image > getLinkedImage()
Get linked Image.
Definition: WellSample.cpp:416
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & setLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Set linked PlateAcquisition.
Definition: WellSample.cpp:463
void setPositionX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionX)
Set the PositionX property.
Definition: WellSample.cpp:353
WellSample & operator=(const WellSample &)
Assignment operator (deleted).
Private implementation details of WellSample model object.
Definition: WellSample.cpp:75
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & getLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index) const
Get linked PlateAcquisition.
Definition: WellSample.cpp:457
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
virtual ~WellSample()
Destructor.
Definition: WellSample.cpp:182
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: WellSample.cpp:203
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionY()
Get the PositionY property.
Definition: WellSample.cpp:360
static ome::compat::shared_ptr< WellSample > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a WellSample model object from DOM element.
Definition: WellSample.cpp:187
void setWell(ome::compat::weak_ptr< ome::xml::model::Well > &well_BackReference)
Set the Well property.
Definition: WellSample.cpp:517
void unlinkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: WellSample.cpp:435
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionX()
Get the PositionX property.
Definition: WellSample.cpp:339
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: WellSample.cpp:445
Open Microscopy Environment C++ implementation.
bool unlinkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: WellSample.cpp:486
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: WellSample.cpp:530
WellSample model object.
Definition: WellSample.h:85
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: WellSample.cpp:451
void setPositionY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionY)
Set the PositionY property.
Definition: WellSample.cpp:374
void linkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: WellSample.cpp:429
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: WellSample.h:88
void setTimepoint(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &timepoint)
Set the Timepoint property.
Definition: WellSample.cpp:395
A quantity of a defined unit.
Definition: Quantity.h:57
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: WellSample.cpp:619
WellSample()
Default constructor.
Definition: WellSample.cpp:163
const std::string & elementName() const
Get the element name of this model object.
Definition: WellSample.cpp:196
const ome::xml::model::primitives::NonNegativeInteger & getIndex() const
Get the Index property.
Definition: WellSample.cpp:325
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getTimepoint()
Get the Timepoint property.
Definition: WellSample.cpp:381
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: WellSample.cpp:299
const std::string & getID() const
Get the ID property.
Definition: WellSample.cpp:402
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119