46 #ifndef OME_XML_MODEL_PLATE_H 47 #define OME_XML_MODEL_PLATE_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/detail/OMEModelObject.h> 65 #include <ome/xml/model/enums/NamingConvention.h> 66 #include <ome/xml/model/enums/UnitsLength.h> 67 #include <ome/xml/model/primitives/NonNegativeInteger.h> 68 #include <ome/xml/model/primitives/PositiveInteger.h> 80 class PlateAcquisition;
92 ome::compat::shared_ptr<Impl>
impl;
123 static ome::compat::shared_ptr< Plate>
153 link (ome::compat::shared_ptr<Reference>& reference,
154 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
161 ome::compat::shared_ptr<std::string>
169 const ome::compat::shared_ptr<std::string>
178 setStatus (ome::compat::shared_ptr<std::string>& status);
185 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
193 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
202 setRows (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& rows);
209 ome::compat::shared_ptr<std::string>
217 const ome::compat::shared_ptr<std::string>
233 ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
241 const ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
250 setRowNamingConvention (ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>& rowNamingConvention);
257 ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
265 const ome::compat::shared_ptr<ome::xml::model::enums::NamingConvention>
281 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
289 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
298 setFieldIndex (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& fieldIndex);
305 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
313 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
322 setColumns (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& columns);
329 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
337 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
353 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
361 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
386 setID (
const std::string&
id);
393 ome::compat::shared_ptr<std::string>
401 const ome::compat::shared_ptr<std::string>
410 setName (ome::compat::shared_ptr<std::string>& name);
417 ome::compat::shared_ptr<std::string>
425 const ome::compat::shared_ptr<std::string>
434 setDescription (ome::compat::shared_ptr<std::string>& description);
441 std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type
450 std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >&
459 const std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >&
469 ome::compat::shared_ptr<ome::xml::model::Well>&
470 getWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index);
479 const ome::compat::shared_ptr<ome::xml::model::Well>&
480 getWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index)
const;
490 setWell (std::vector<ome::compat::shared_ptr<ome::xml::model::Well> >::size_type index,
491 ome::compat::shared_ptr<ome::xml::model::Well>& well);
502 addWell (ome::compat::shared_ptr<ome::xml::model::Well>& well);
514 removeWell (ome::compat::shared_ptr<ome::xml::model::Well>& well);
539 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
552 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
554 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
567 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
585 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
592 std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type
601 std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >&
610 const std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >&
620 ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>&
621 getPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index);
630 const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>&
631 getPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index)
const;
641 setPlateAcquisition (std::vector<ome::compat::shared_ptr<ome::xml::model::PlateAcquisition> >::size_type index,
642 ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
653 addPlateAcquisition (ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
690 const ome::compat::weak_ptr<ome::xml::model::Screen>&
703 const ome::compat::weak_ptr<ome::xml::model::Screen>&
705 const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
718 linkScreen (
const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
736 unlinkScreen (
const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
759 #endif // OME_XML_MODEL_PLATE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setWell(std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Well > &well)
Set Well.
Definition: Plate.cpp:754
bool linkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Plate.cpp:928
virtual ~Plate()
Destructor.
Definition: Plate.cpp:242
Plate model object.
Definition: Plate.h:87
const std::string & elementName() const
Get the element name of this model object.
Definition: Plate.cpp:256
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plate.cpp:824
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: Plate.cpp:271
const ome::compat::weak_ptr< ome::xml::model::Screen > & getLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index) const
Get linked Screen.
Definition: Plate.cpp:912
void setWellOriginX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &wellOriginX)
Set the WellOriginX property.
Definition: Plate.cpp:661
void removeWell(ome::compat::shared_ptr< ome::xml::model::Well > &well)
Remove Well.
Definition: Plate.cpp:771
void setID(const std::string &id)
Set the ID property.
Definition: Plate.cpp:675
const std::string & getID() const
Get the ID property.
Definition: Plate.cpp:668
Plate & operator=(const Plate &)
Assignment operator (deleted).
void setWellOriginY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &wellOriginY)
Set the WellOriginY property.
Definition: Plate.cpp:640
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: Plate.cpp:794
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
const ome::compat::weak_ptr< ome::xml::model::Screen > & setLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Set linked Screen.
Definition: Plate.cpp:918
void addPlateAcquisition(ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Add PlateAcquisition.
Definition: Plate.cpp:881
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plate.cpp:810
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getColumns()
Get the Columns property.
Definition: Plate.cpp:605
void setRowNamingConvention(ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &rowNamingConvention)
Set the RowNamingConvention property.
Definition: Plate.cpp:556
void setRows(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &rows)
Set the Rows property.
Definition: Plate.cpp:514
ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > getRowNamingConvention()
Get the RowNamingConvention property.
Definition: Plate.cpp:542
Plate()
Default constructor.
Definition: Plate.cpp:227
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Plate.cpp:703
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Plate.cpp:717
void setExternalIdentifier(ome::compat::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Plate.cpp:535
void setStatus(ome::compat::shared_ptr< std::string > &status)
Set the Status property.
Definition: Plate.cpp:493
ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & getPlateAcquisition(std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index)
Get PlateAcquisition.
Definition: Plate.cpp:860
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Plate.cpp:263
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: Plate.cpp:964
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plate.cpp:788
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & getWellList()
Get the Well list.
Definition: Plate.cpp:730
Open Microscopy Environment C++ implementation.
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type sizeOfPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: Plate.cpp:842
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Plate.cpp:682
void addWell(ome::compat::shared_ptr< ome::xml::model::Well > &well)
Add Well.
Definition: Plate.cpp:763
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getRows()
Get the Rows property.
Definition: Plate.cpp:500
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: Plate.cpp:448
void setColumns(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &columns)
Set the Columns property.
Definition: Plate.cpp:619
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plate.cpp:782
void setColumnNamingConvention(ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &columnNamingConvention)
Set the ColumnNamingConvention property.
Definition: Plate.cpp:577
void setFieldIndex(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fieldIndex)
Set the FieldIndex property.
Definition: Plate.cpp:598
ome::compat::shared_ptr< std::string > getStatus()
Get the Status property.
Definition: Plate.cpp:479
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type sizeOfWellList() const
Get size of linked Well list.
Definition: Plate.cpp:724
ome::compat::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Plate.cpp:521
void removePlateAcquisition(ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Remove PlateAcquisition.
Definition: Plate.cpp:889
ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > getColumnNamingConvention()
Get the ColumnNamingConvention property.
Definition: Plate.cpp:563
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type sizeOfLinkedScreenList() const
Get size of linked Screen list.
Definition: Plate.cpp:900
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFieldIndex()
Get the FieldIndex property.
Definition: Plate.cpp:584
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plate.cpp:1179
A quantity of a defined unit.
Definition: Quantity.h:57
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWellOriginX()
Get the WellOriginX property.
Definition: Plate.cpp:647
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Plate.cpp:957
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Plate.cpp:696
bool unlinkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Plate.cpp:941
void setPlateAcquisition(std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index, ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Set PlateAcquisition.
Definition: Plate.cpp:872
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWellOriginY()
Get the WellOriginY property.
Definition: Plate.cpp:626
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & getPlateAcquisitionList()
Get the PlateAcquisition list.
Definition: Plate.cpp:848
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: Plate.cpp:800
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Plate.cpp:906
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Plate.h:90
Private implementation details of Plate model object.
Definition: Plate.cpp:83
ome::compat::shared_ptr< ome::xml::model::Well > & getWell(std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index)
Get Well.
Definition: Plate.cpp:742
static ome::compat::shared_ptr< Plate > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Plate model object from DOM element.
Definition: Plate.cpp:247