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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/detail/OMEModelObject.h> 64 #include <ome/xml/model/enums/NamingConvention.h> 65 #include <ome/xml/model/enums/UnitsLength.h> 66 #include <ome/xml/model/primitives/NonNegativeInteger.h> 67 #include <ome/xml/model/primitives/PositiveInteger.h> 79 class PlateAcquisition;
91 std::shared_ptr<Impl>
impl;
122 static std::shared_ptr<Plate>
152 link (std::shared_ptr<Reference>& reference,
153 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
160 std::shared_ptr<std::string>
168 const std::shared_ptr<std::string>
177 setStatus (std::shared_ptr<std::string>& status);
184 std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
192 const std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
201 setRows (std::shared_ptr<ome::xml::model::primitives::PositiveInteger>& rows);
208 std::shared_ptr<std::string>
216 const std::shared_ptr<std::string>
232 std::shared_ptr<ome::xml::model::enums::NamingConvention>
240 const std::shared_ptr<ome::xml::model::enums::NamingConvention>
256 std::shared_ptr<ome::xml::model::enums::NamingConvention>
264 const std::shared_ptr<ome::xml::model::enums::NamingConvention>
280 std::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
288 const std::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
297 setFieldIndex (std::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& fieldIndex);
304 std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
312 const std::shared_ptr<ome::xml::model::primitives::PositiveInteger>
321 setColumns (std::shared_ptr<ome::xml::model::primitives::PositiveInteger>& columns);
328 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
336 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
352 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
360 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
385 setID (
const std::string&
id);
392 std::shared_ptr<std::string>
400 const std::shared_ptr<std::string>
409 setName (std::shared_ptr<std::string>& name);
416 std::shared_ptr<std::string>
424 const std::shared_ptr<std::string>
440 std::vector<std::shared_ptr<ome::xml::model::Well>>::size_type
449 std::vector<std::shared_ptr<ome::xml::model::Well>>&
458 const std::vector<std::shared_ptr<ome::xml::model::Well>>&
468 std::shared_ptr<ome::xml::model::Well>&
469 getWell (std::vector<std::shared_ptr<ome::xml::model::Well>>::size_type index);
478 const std::shared_ptr<ome::xml::model::Well>&
479 getWell (std::vector<std::shared_ptr<ome::xml::model::Well>>::size_type index)
const;
489 setWell (std::vector<std::shared_ptr<ome::xml::model::Well>>::size_type index,
490 std::shared_ptr<ome::xml::model::Well>& well);
501 addWell (std::shared_ptr<ome::xml::model::Well>& well);
513 removeWell (std::shared_ptr<ome::xml::model::Well>& well);
538 const std::weak_ptr<ome::xml::model::Annotation>&
551 const std::weak_ptr<ome::xml::model::Annotation>&
553 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
566 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
584 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
591 std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>::size_type
600 std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>&
609 const std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>&
619 std::shared_ptr<ome::xml::model::PlateAcquisition>&
620 getPlateAcquisition (std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>::size_type index);
629 const std::shared_ptr<ome::xml::model::PlateAcquisition>&
630 getPlateAcquisition (std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>::size_type index)
const;
640 setPlateAcquisition (std::vector<std::shared_ptr<ome::xml::model::PlateAcquisition>>::size_type index,
641 std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
652 addPlateAcquisition (std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition);
689 const std::weak_ptr<ome::xml::model::Screen>&
702 const std::weak_ptr<ome::xml::model::Screen>&
704 const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
717 linkScreen (
const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
735 unlinkScreen (
const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
753 #endif // OME_XML_MODEL_PLATE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
void setExternalIdentifier(std::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Plate.cpp:527
virtual ~Plate()
Destructor.
Definition: Plate.cpp:242
void setFieldIndex(std::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fieldIndex)
Set the FieldIndex property.
Definition: Plate.cpp:590
std::shared_ptr< std::string > getStatus()
Get the Status property.
Definition: Plate.cpp:471
Plate model object.
Definition: Plate.h:86
std::shared_ptr< ome::xml::model::enums::NamingConvention > getColumnNamingConvention()
Get the ColumnNamingConvention property.
Definition: Plate.cpp:555
const std::string & elementName() const
Get the element name of this model object.
Definition: Plate.cpp:256
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type sizeOfLinkedScreenList() const
Get size of linked Screen list.
Definition: Plate.cpp:892
std::shared_ptr< ome::xml::model::primitives::PositiveInteger > getRows()
Get the Rows property.
Definition: Plate.cpp:492
bool unlinkScreen(const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Plate.cpp:933
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Plate.cpp:695
bool linkScreen(const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Plate.cpp:920
std::vector< std::shared_ptr< ome::xml::model::Well > >::size_type sizeOfWellList() const
Get size of linked Well list.
Definition: Plate.cpp:716
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:269
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: Plate.cpp:786
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWellOriginX()
Get the WellOriginX property.
Definition: Plate.cpp:639
void setID(const std::string &id)
Set the ID property.
Definition: Plate.cpp:667
std::shared_ptr< ome::xml::model::Well > & getWell(std::vector< std::shared_ptr< ome::xml::model::Well >>::size_type index)
Get Well.
Definition: Plate.cpp:734
const std::string & getID() const
Get the ID property.
Definition: Plate.cpp:660
Plate & operator=(const Plate &)
Assignment operator (deleted).
std::shared_ptr< ome::xml::model::enums::NamingConvention > getRowNamingConvention()
Get the RowNamingConvention property.
Definition: Plate.cpp:534
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plate.cpp:802
std::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Plate.cpp:513
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
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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: Plate.cpp:792
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Plate.cpp:674
Plate()
Default constructor.
Definition: Plate.cpp:227
void removePlateAcquisition(std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Remove PlateAcquisition.
Definition: Plate.cpp:881
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: Plate.cpp:440
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
std::vector< std::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type sizeOfPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: Plate.cpp:834
std::vector< std::shared_ptr< ome::xml::model::PlateAcquisition > > & getPlateAcquisitionList()
Get the PlateAcquisition list.
Definition: Plate.cpp:840
void setRows(std::shared_ptr< ome::xml::model::primitives::PositiveInteger > &rows)
Set the Rows property.
Definition: Plate.cpp:506
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plate.cpp:816
void setWellOriginY(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &wellOriginY)
Set the WellOriginY property.
Definition: Plate.cpp:632
Open Microscopy Environment C++ implementation.
void setColumns(std::shared_ptr< ome::xml::model::primitives::PositiveInteger > &columns)
Set the Columns property.
Definition: Plate.cpp:611
const std::weak_ptr< ome::xml::model::Screen > & getLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index) const
Get linked Screen.
Definition: Plate.cpp:904
std::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFieldIndex()
Get the FieldIndex property.
Definition: Plate.cpp:576
const std::weak_ptr< ome::xml::model::Screen > & setLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Set linked Screen.
Definition: Plate.cpp:910
std::shared_ptr< ome::xml::model::PlateAcquisition > & getPlateAcquisition(std::vector< std::shared_ptr< ome::xml::model::PlateAcquisition >>::size_type index)
Get PlateAcquisition.
Definition: Plate.cpp:852
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: Plate.cpp:949
void setRowNamingConvention(std::shared_ptr< ome::xml::model::enums::NamingConvention > &rowNamingConvention)
Set the RowNamingConvention property.
Definition: Plate.cpp:548
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Plate.cpp:688
void setWellOriginX(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &wellOriginX)
Set the WellOriginX property.
Definition: Plate.cpp:653
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plate.cpp:1131
A quantity of a defined unit.
Definition: Quantity.h:57
void setWell(std::vector< std::shared_ptr< ome::xml::model::Well >>::size_type index, std::shared_ptr< ome::xml::model::Well > &well)
Set Well.
Definition: Plate.cpp:746
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Plate.h:89
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Plate.cpp:709
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plate.cpp:774
std::vector< std::shared_ptr< ome::xml::model::Well > > & getWellList()
Get the Well list.
Definition: Plate.cpp:722
std::shared_ptr< ome::xml::model::primitives::PositiveInteger > getColumns()
Get the Columns property.
Definition: Plate.cpp:597
void removeWell(std::shared_ptr< ome::xml::model::Well > &well)
Remove Well.
Definition: Plate.cpp:763
void setStatus(std::shared_ptr< std::string > &status)
Set the Status property.
Definition: Plate.cpp:485
void addPlateAcquisition(std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Add PlateAcquisition.
Definition: Plate.cpp:873
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWellOriginY()
Get the WellOriginY property.
Definition: Plate.cpp:618
void setColumnNamingConvention(std::shared_ptr< ome::xml::model::enums::NamingConvention > &columnNamingConvention)
Set the ColumnNamingConvention property.
Definition: Plate.cpp:569
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plate.cpp:780
void addWell(std::shared_ptr< ome::xml::model::Well > &well)
Add Well.
Definition: Plate.cpp:755
static std::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
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Plate.cpp:898
Private implementation details of Plate model object.
Definition: Plate.cpp:83
void setPlateAcquisition(std::vector< std::shared_ptr< ome::xml::model::PlateAcquisition >>::size_type index, std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
Set PlateAcquisition.
Definition: Plate.cpp:864