46 #ifndef OME_XML_MODEL_PROJECT_H 47 #define OME_XML_MODEL_PROJECT_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/Experimenter.h> 64 #include <ome/xml/model/ExperimenterGroup.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 87 std::shared_ptr<Impl>
impl;
118 static std::shared_ptr<Project>
148 link (std::shared_ptr<Reference>& reference,
149 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
156 std::shared_ptr<std::string>
164 const std::shared_ptr<std::string>
173 setName (std::shared_ptr<std::string>& name);
189 setID (
const std::string&
id);
196 std::shared_ptr<std::string>
204 const std::shared_ptr<std::string>
221 std::weak_ptr<ome::xml::model::Experimenter>
230 const std::weak_ptr<ome::xml::model::Experimenter>
239 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
259 std::weak_ptr<ome::xml::model::ExperimenterGroup>
268 const std::weak_ptr<ome::xml::model::ExperimenterGroup>
314 const std::weak_ptr<ome::xml::model::Dataset>&
327 const std::weak_ptr<ome::xml::model::Dataset>&
329 const std::shared_ptr<ome::xml::model::Dataset>& dataset);
342 linkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset);
360 unlinkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset);
385 const std::weak_ptr<ome::xml::model::Annotation>&
398 const std::weak_ptr<ome::xml::model::Annotation>&
400 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
413 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
431 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
449 #endif // OME_XML_MODEL_PROJECT_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
Project model object.
Definition: Project.h:82
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Project.cpp:536
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Project.cpp:578
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Project.cpp:431
Project & operator=(const Project &)
Assignment operator (deleted).
bool unlinkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset)
Unlink Dataset.
Definition: Project.cpp:518
static std::shared_ptr< Project > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Project model object from DOM element.
Definition: Project.cpp:179
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
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Project.cpp:376
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Project.cpp:195
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Project.cpp:411
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: Project.cpp:201
const std::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dataset > &dataset)
Set linked Dataset.
Definition: Project.cpp:494
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Project.cpp:710
void setID(const std::string &id)
Set the ID property.
Definition: Project.cpp:390
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
Project()
Default constructor.
Definition: Project.cpp:159
void linkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Project.cpp:460
const std::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Project.cpp:488
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Project.cpp:418
Open Microscopy Environment C++ implementation.
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Project.cpp:564
bool linkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset)
Link Dataset.
Definition: Project.cpp:504
const std::string & getID() const
Get the ID property.
Definition: Project.cpp:383
virtual ~Project()
Destructor.
Definition: Project.cpp:174
Private implementation details of Project model object.
Definition: Project.cpp:78
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Project.cpp:476
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Project.cpp:362
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Project.cpp:437
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Project.cpp:542
std::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Project.cpp:447
const std::string & elementName() const
Get the element name of this model object.
Definition: Project.cpp:188
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: Project.cpp:554
void unlinkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Project.cpp:466
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Project.cpp:397
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Project.h:85
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Project.cpp:482
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: Project.cpp:293
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: Project.cpp:548
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: Project.cpp:595