ome-xml
5.2.0
|
MicrobeamManipulation model object. More...
#include <ome/xml/model/MicrobeamManipulation.h>
Classes | |
class | Impl |
Private implementation details of MicrobeamManipulation model object. More... | |
Public Member Functions | |
MicrobeamManipulation () | |
Default constructor. | |
MicrobeamManipulation (const MicrobeamManipulation ©) | |
Copy constructor. More... | |
virtual | ~MicrobeamManipulation () |
Destructor. | |
const std::string & | elementName () const |
Get the element name of this model object. More... | |
bool | validElementName (const std::string &name) const |
Check if a given element name is valid for processing by this model object. More... | |
virtual void | update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
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. More... | |
ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > | getType () |
Get the Type property. More... | |
const ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > | getType () const |
Get the Type property. More... | |
void | setType (ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > &type) |
Set the Type property. More... | |
const std::string & | getID () const |
Get the ID property. More... | |
void | setID (const std::string &id) |
Set the ID property. More... | |
ome::compat::shared_ptr< std::string > | getDescription () |
Get the Description property. More... | |
const ome::compat::shared_ptr< std::string > | getDescription () const |
Get the Description property. More... | |
void | setDescription (ome::compat::shared_ptr< std::string > &description) |
Set the Description property. More... | |
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedROIList () const |
Get size of linked ROI list. More... | |
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type | getLinkedROIList () const |
Get the linked ROI list. More... | |
const ome::compat::weak_ptr< ome::xml::model::ROI > & | getLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index) const |
Get linked ROI. More... | |
const ome::compat::weak_ptr< ome::xml::model::ROI > & | setLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ROI > &roi) |
Set linked ROI. More... | |
bool | linkROI (const ome::compat::shared_ptr< ome::xml::model::ROI > &roi) |
Link ROI. More... | |
bool | unlinkROI (const ome::compat::shared_ptr< ome::xml::model::ROI > &roi) |
Unlink ROI. More... | |
ome::compat::weak_ptr< ome::xml::model::Experimenter > | getLinkedExperimenter () |
Get linked Experimenter. More... | |
const ome::compat::weak_ptr< ome::xml::model::Experimenter > | getLinkedExperimenter () const |
Get linked Experimenter. More... | |
void | linkExperimenter (ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter) |
Link Experimenter. More... | |
void | unlinkExperimenter (ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter) |
Unlink Experimenter. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type | sizeOfLightSourceSettingsList () const |
Get size of linked LightSourceSettings list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & | getLightSourceSettingsList () |
Get the LightSourceSettings list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & | getLightSourceSettingsList () const |
Get the LightSourceSettings list. More... | |
ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & | getLightSourceSettings (std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type index) |
Get LightSourceSettings. More... | |
const ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & | getLightSourceSettings (std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type index) const |
Get LightSourceSettings. More... | |
void | setLightSourceSettings (std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type index, ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings) |
Set LightSourceSettings. More... | |
void | addLightSourceSettings (ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings) |
Add LightSourceSettings. More... | |
void | removeLightSourceSettings (ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings) |
Remove LightSourceSettings. More... | |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedImageList () const |
Get size of linked Image list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type | getLinkedImageList () const |
Get the linked Image list. More... | |
const ome::compat::weak_ptr< ome::xml::model::Image > & | getLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const |
Get linked Image. More... | |
const ome::compat::weak_ptr< ome::xml::model::Image > & | setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference) |
Set linked Image. More... | |
bool | linkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference) |
Link Image. More... | |
bool | unlinkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference) |
Unlink Image. More... | |
ome::compat::weak_ptr< ome::xml::model::Experiment > | getExperiment () |
Get the Experiment property. More... | |
const ome::compat::weak_ptr< ome::xml::model::Experiment > | getExperiment () const |
Get the Experiment property. More... | |
void | setExperiment (ome::compat::weak_ptr< ome::xml::model::Experiment > &experiment_BackReference) |
Set the Experiment property. More... | |
virtual common::xml::dom::Element | asXMLElement (common::xml::dom::Document &document) const |
Transform the object hierarchy rooted at this element to XML. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
virtual | ~OMEModelObject () |
Destructor. | |
virtual void | update (const common::xml::dom::Element &element,::ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
virtual 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. More... | |
Public Member Functions inherited from ome::xml::model::OMEModelObject | |
virtual bool | link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< OMEModelObject > &object)=0 |
Link a given OME model object to this model object. More... | |
Static Public Member Functions | |
static ome::compat::shared_ptr< MicrobeamManipulation > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a MicrobeamManipulation model object from DOM element. More... | |
Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
Retrieve all the children of an element that have a given tag name. More... | |
static std::string | stripNamespacePrefix (const std::string &value) |
Strip the namespace prefix from a tag name. More... | |
Protected Member Functions | |
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. More... | |
Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. | |
OMEModelObject (const OMEModelObject ©) | |
Copy constructor. More... | |
template<class C , typename T > | |
bool | contains (const C &container, const ome::compat::shared_ptr< T > &element) |
Check if a container contains a particular element. More... | |
Protected Member Functions inherited from ome::xml::model::OMEModelObject | |
OMEModelObject () | |
Constructor. | |
Private Attributes | |
ome::compat::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
ome::common::Logger | logger |
Message logger. | |
MicrobeamManipulation model object.
ome::xml::model::MicrobeamManipulation::MicrobeamManipulation | ( | const MicrobeamManipulation & | copy | ) |
Copy constructor.
copy | the MicrobeamManipulation to copy. |
void ome::xml::model::MicrobeamManipulation::addLightSourceSettings | ( | ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & | lightSourceSettings | ) |
Add LightSourceSettings.
lightSourceSettings | the LightSourceSettings to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
|
virtual |
Transform the object hierarchy rooted at this element to XML.
document | document for element creation |
Implements ome::xml::model::OMEModelObject.
References asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), and getXMLNamespace().
|
protectedvirtual |
Transform the object hierarchy rooted at this element to XML.
This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.
document | XML document for element creation. |
element | XML element for setting model data. |
Implements ome::xml::model::detail::OMEModelObject.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().
Referenced by asXMLElement().
|
static |
Create a MicrobeamManipulation model object from DOM element.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Referenced by ome::xml::model::Experiment::update().
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
Implements ome::xml::model::OMEModelObject.
ome::compat::shared_ptr< std::string > ome::xml::model::MicrobeamManipulation::getDescription | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::MicrobeamManipulation::getDescription | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::Experiment > ome::xml::model::MicrobeamManipulation::getExperiment | ( | ) |
const ome::compat::weak_ptr< ome::xml::model::Experiment > ome::xml::model::MicrobeamManipulation::getExperiment | ( | ) | const |
const std::string & ome::xml::model::MicrobeamManipulation::getID | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & ome::xml::model::MicrobeamManipulation::getLightSourceSettings | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type | index | ) |
Get LightSourceSettings.
index | the index number of the LightSourceSettings. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & ome::xml::model::MicrobeamManipulation::getLightSourceSettings | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type | index | ) | const |
Get LightSourceSettings.
index | the index number of the LightSourceSettings. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & ome::xml::model::MicrobeamManipulation::getLightSourceSettingsList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & ome::xml::model::MicrobeamManipulation::getLightSourceSettingsList | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::MicrobeamManipulation::getLinkedExperimenter | ( | ) |
const ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::MicrobeamManipulation::getLinkedExperimenter | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::MicrobeamManipulation::getLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | index | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type ome::xml::model::MicrobeamManipulation::getLinkedImageList | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::ROI > & ome::xml::model::MicrobeamManipulation::getLinkedROI | ( | OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type | index | ) | const |
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type ome::xml::model::MicrobeamManipulation::getLinkedROIList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > ome::xml::model::MicrobeamManipulation::getType | ( | ) |
const ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > ome::xml::model::MicrobeamManipulation::getType | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElement(), and asXMLElementInternal().
bool ome::xml::model::MicrobeamManipulation::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.
reference | type qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef. |
object | Model object to link to. |
true
if this model object was able to handle the reference, otherwise false
.References impl, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::ROI::linkMicrobeamManipulation(), ome::xml::model::Experimenter::linkMicrobeamManipulation(), and ome::xml::model::detail::OMEModelObject::logger.
void ome::xml::model::MicrobeamManipulation::linkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
bool ome::xml::model::MicrobeamManipulation::linkImage | ( | const ome::compat::shared_ptr< ome::xml::model::Image > & | image_BackReference | ) |
Link Image.
image_BackReference | the Image to link. |
true
if the object was added to the internal imageLinks list, otherwise false
.References impl.
Referenced by ome::xml::model::Image::link().
bool ome::xml::model::MicrobeamManipulation::linkROI | ( | const ome::compat::shared_ptr< ome::xml::model::ROI > & | roi | ) |
void ome::xml::model::MicrobeamManipulation::removeLightSourceSettings | ( | ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & | lightSourceSettings | ) |
Remove LightSourceSettings.
lightSourceSettings | the LightSourceSettings to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::MicrobeamManipulation::setDescription | ( | ome::compat::shared_ptr< std::string > & | description | ) |
void ome::xml::model::MicrobeamManipulation::setExperiment | ( | ome::compat::weak_ptr< ome::xml::model::Experiment > & | experiment_BackReference | ) |
void ome::xml::model::MicrobeamManipulation::setID | ( | const std::string & | id | ) |
void ome::xml::model::MicrobeamManipulation::setLightSourceSettings | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & | lightSourceSettings | ||
) |
Set LightSourceSettings.
index | the index number of the LightSourceSettings. |
lightSourceSettings | the LightSourceSettings to set. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::MicrobeamManipulation::setLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::Image > & | image_BackReference | ||
) |
const ome::compat::weak_ptr< ome::xml::model::ROI > & ome::xml::model::MicrobeamManipulation::setLinkedROI | ( | OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::ROI > & | roi | ||
) |
void ome::xml::model::MicrobeamManipulation::setType | ( | ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > & | type | ) |
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type ome::xml::model::MicrobeamManipulation::sizeOfLightSourceSettingsList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type ome::xml::model::MicrobeamManipulation::sizeOfLinkedImageList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type ome::xml::model::MicrobeamManipulation::sizeOfLinkedROIList | ( | ) | const |
void ome::xml::model::MicrobeamManipulation::unlinkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
Unlink Experimenter.
experimenter | the Experimenter to unlink. |
link(0)
internally. References impl.
bool ome::xml::model::MicrobeamManipulation::unlinkImage | ( | const ome::compat::shared_ptr< ome::xml::model::Image > & | image_BackReference | ) |
Unlink Image.
image_BackReference | the Image to unlink. |
true
if the Image was unlinked, otherwise false
if the Image was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
bool ome::xml::model::MicrobeamManipulation::unlinkROI | ( | const ome::compat::shared_ptr< ome::xml::model::ROI > & | roi | ) |
Unlink ROI.
roi | the ROI to unlink. |
true
if the ROI was unlinked, otherwise false
if the ROI was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Implements ome::xml::model::OMEModelObject.
References addLightSourceSettings(), ome::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::xml::model::LightSourceSettings::create(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setDescription(), setID(), setType(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
name | the element name to check. |
true
if valid, false
if invalid. Implements ome::xml::model::detail::OMEModelObject.
References ome::xml::model::detail::OMEModelObject::validElementName().
Referenced by update().