46 #ifndef OME_XML_MODEL_SCREEN_H 47 #define OME_XML_MODEL_SCREEN_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> 86 std::shared_ptr<Impl>
impl;
117 static std::shared_ptr<Screen>
147 link (std::shared_ptr<Reference>& reference,
148 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
155 std::shared_ptr<std::string>
163 const std::shared_ptr<std::string>
172 setName (std::shared_ptr<std::string>& name);
179 std::shared_ptr<std::string>
187 const std::shared_ptr<std::string>
203 std::shared_ptr<std::string>
211 const std::shared_ptr<std::string>
227 std::shared_ptr<std::string>
235 const std::shared_ptr<std::string>
251 std::shared_ptr<std::string>
259 const std::shared_ptr<std::string>
268 setType (std::shared_ptr<std::string>& type);
284 setID (
const std::string&
id);
291 std::shared_ptr<std::string>
299 const std::shared_ptr<std::string>
315 std::shared_ptr<std::string>
323 const std::shared_ptr<std::string>
339 std::vector<std::shared_ptr<ome::xml::model::Reagent>>::size_type
348 std::vector<std::shared_ptr<ome::xml::model::Reagent>>&
357 const std::vector<std::shared_ptr<ome::xml::model::Reagent>>&
367 std::shared_ptr<ome::xml::model::Reagent>&
368 getReagent (std::vector<std::shared_ptr<ome::xml::model::Reagent>>::size_type index);
377 const std::shared_ptr<ome::xml::model::Reagent>&
378 getReagent (std::vector<std::shared_ptr<ome::xml::model::Reagent>>::size_type index)
const;
388 setReagent (std::vector<std::shared_ptr<ome::xml::model::Reagent>>::size_type index,
389 std::shared_ptr<ome::xml::model::Reagent>& reagent);
400 addReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
412 removeReagent (std::shared_ptr<ome::xml::model::Reagent>& reagent);
437 const std::weak_ptr<ome::xml::model::Plate>&
450 const std::weak_ptr<ome::xml::model::Plate>&
452 const std::shared_ptr<ome::xml::model::Plate>& plate);
465 linkPlate (
const std::shared_ptr<ome::xml::model::Plate>& plate);
483 unlinkPlate (
const std::shared_ptr<ome::xml::model::Plate>& plate);
508 const std::weak_ptr<ome::xml::model::Annotation>&
521 const std::weak_ptr<ome::xml::model::Annotation>&
523 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
536 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
554 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
572 #endif // OME_XML_MODEL_SCREEN_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Screen.cpp:722
static std::shared_ptr< Screen > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Screen model object from DOM element.
Definition: Screen.cpp:205
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Screen.cpp:401
bool unlinkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate)
Unlink Plate.
Definition: Screen.cpp:662
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: Screen.cpp:698
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type sizeOfLinkedPlateList() const
Get size of linked Plate list.
Definition: Screen.cpp:620
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
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Screen.cpp:686
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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: Screen.cpp:692
Screen()
Default constructor.
Definition: Screen.cpp:185
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Screen.cpp:221
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: Screen.cpp:227
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Screen.h:84
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Screen.cpp:415
void setReagent(std::vector< std::shared_ptr< ome::xml::model::Reagent >>::size_type index, std::shared_ptr< ome::xml::model::Reagent > &reagent)
Set Reagent.
Definition: Screen.cpp:592
std::shared_ptr< std::string > getProtocolDescription()
Get the ProtocolDescription property.
Definition: Screen.cpp:422
bool linkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate)
Link Plate.
Definition: Screen.cpp:648
const std::weak_ptr< ome::xml::model::Plate > & getLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index) const
Get linked Plate.
Definition: Screen.cpp:632
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Screen.cpp:708
void addReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Add Reagent.
Definition: Screen.cpp:601
std::shared_ptr< std::string > getType()
Get the Type property.
Definition: Screen.cpp:485
void setType(std::shared_ptr< std::string > &type)
Set the Type property.
Definition: Screen.cpp:499
Screen model object.
Definition: Screen.h:81
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
std::shared_ptr< ome::xml::model::Reagent > & getReagent(std::vector< std::shared_ptr< ome::xml::model::Reagent >>::size_type index)
Get Reagent.
Definition: Screen.cpp:580
Open Microscopy Environment C++ implementation.
void setReagentSetIdentifier(std::shared_ptr< std::string > &reagentSetIdentifier)
Set the ReagentSetIdentifier property.
Definition: Screen.cpp:534
Screen & operator=(const Screen &)
Assignment operator (deleted).
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: Screen.cpp:739
std::shared_ptr< std::string > getReagentSetDescription()
Get the ReagentSetDescription property.
Definition: Screen.cpp:464
std::vector< std::shared_ptr< ome::xml::model::Reagent > >::size_type sizeOfReagentList() const
Get size of linked Reagent list.
Definition: Screen.cpp:562
void removeReagent(std::shared_ptr< ome::xml::model::Reagent > &reagent)
Remove Reagent.
Definition: Screen.cpp:609
void setProtocolDescription(std::shared_ptr< std::string > &protocolDescription)
Set the ProtocolDescription property.
Definition: Screen.cpp:436
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Screen.cpp:680
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: Screen.cpp:354
virtual ~Screen()
Destructor.
Definition: Screen.cpp:200
void setProtocolIdentifier(std::shared_ptr< std::string > &protocolIdentifier)
Set the ProtocolIdentifier property.
Definition: Screen.cpp:457
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Screen.cpp:555
void setReagentSetDescription(std::shared_ptr< std::string > &reagentSetDescription)
Set the ReagentSetDescription property.
Definition: Screen.cpp:478
const std::string & elementName() const
Get the element name of this model object.
Definition: Screen.cpp:214
const std::string & getID() const
Get the ID property.
Definition: Screen.cpp:506
Private implementation details of Screen model object.
Definition: Screen.cpp:76
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Screen.cpp:887
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Screen.cpp:541
const std::weak_ptr< ome::xml::model::Plate > & setLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Plate > &plate)
Set linked Plate.
Definition: Screen.cpp:638
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Screen.cpp:626
std::vector< std::shared_ptr< ome::xml::model::Reagent > > & getReagentList()
Get the Reagent list.
Definition: Screen.cpp:568
std::shared_ptr< std::string > getProtocolIdentifier()
Get the ProtocolIdentifier property.
Definition: Screen.cpp:443
std::shared_ptr< std::string > getReagentSetIdentifier()
Get the ReagentSetIdentifier property.
Definition: Screen.cpp:520
void setID(const std::string &id)
Set the ID property.
Definition: Screen.cpp:513