ome-xml  5.6.0
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::MicrobeamManipulation Class Reference

MicrobeamManipulation model object. More...

#include <ome/xml/model/MicrobeamManipulation.h>

+ Inheritance diagram for ome::xml::model::MicrobeamManipulation:
+ Collaboration diagram for ome::xml::model::MicrobeamManipulation:

Classes

class  Impl
 Private implementation details of MicrobeamManipulation model object. More...
 

Public Member Functions

 MicrobeamManipulation ()
 Default constructor.
 
 MicrobeamManipulation (const MicrobeamManipulation &copy)
 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 SKIP 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 (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationTypegetType ()
 Get the Type property. More...
 
const std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationTypegetType () const
 Get the Type property. More...
 
void setType (std::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...
 
std::shared_ptr< std::string > getDescription ()
 Get the Description property. More...
 
const std::shared_ptr< std::string > getDescription () const
 Get the Description property. More...
 
void setDescription (std::shared_ptr< std::string > &description)
 Set the Description property. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList () const
 Get size of linked ROI list. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList () const
 Get the linked ROI list. More...
 
const std::weak_ptr< ome::xml::model::ROI > & getLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index) const
 Get linked ROI. More...
 
const std::weak_ptr< ome::xml::model::ROI > & setLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ROI > &roi)
 Set linked ROI. More...
 
bool linkROI (const std::shared_ptr< ome::xml::model::ROI > &roi)
 Link ROI. More...
 
bool unlinkROI (const std::shared_ptr< ome::xml::model::ROI > &roi)
 Unlink ROI. More...
 
std::weak_ptr< ome::xml::model::ExperimentergetLinkedExperimenter ()
 Get linked Experimenter. More...
 
const std::weak_ptr< ome::xml::model::ExperimentergetLinkedExperimenter () const
 Get linked Experimenter. More...
 
void linkExperimenter (std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Link Experimenter. More...
 
void unlinkExperimenter (std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Unlink Experimenter. More...
 
std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type sizeOfLightSourceSettingsList () const
 Get size of linked LightSourceSettings list. More...
 
std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > > & getLightSourceSettingsList ()
 Get the LightSourceSettings list. More...
 
const std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > > & getLightSourceSettingsList () const
 Get the LightSourceSettings list. More...
 
std::shared_ptr< ome::xml::model::LightSourceSettings > & getLightSourceSettings (std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type index)
 Get LightSourceSettings. More...
 
const std::shared_ptr< ome::xml::model::LightSourceSettings > & getLightSourceSettings (std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type index) const
 Get LightSourceSettings. More...
 
void setLightSourceSettings (std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type index, std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
 Set LightSourceSettings. More...
 
void addLightSourceSettings (std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
 Add LightSourceSettings. More...
 
void removeLightSourceSettings (std::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
 Remove LightSourceSettings. More...
 
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList () const
 Get size of linked Image list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList () const
 Get the linked Image list. More...
 
const std::weak_ptr< ome::xml::model::Image > & getLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index) const
 Get linked Image. More...
 
const std::weak_ptr< ome::xml::model::Image > & setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Set linked Image. More...
 
bool linkImage (const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Link Image. More...
 
bool unlinkImage (const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Unlink Image. More...
 
std::weak_ptr< ome::xml::model::ExperimentgetExperiment ()
 Get the Experiment property. More...
 
const std::weak_ptr< ome::xml::model::ExperimentgetExperiment () const
 Get the Experiment property. More...
 
void setExperiment (std::weak_ptr< ome::xml::model::Experiment > &experiment_BackReference)
 Set the Experiment property. 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 common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. 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...
 
virtual 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. More...
 
- Public Member Functions inherited from ome::xml::model::OMEModelObject
virtual bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Static Public Member Functions

static std::shared_ptr< MicrobeamManipulationcreate (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::ElementgetChildrenByTagName (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 void 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. More...
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const std::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

std::shared_ptr< Implimpl
 Private implementation details.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

MicrobeamManipulation model object.

Constructor & Destructor Documentation

◆ MicrobeamManipulation()

ome::xml::model::MicrobeamManipulation::MicrobeamManipulation ( const MicrobeamManipulation copy)

Copy constructor.

Parameters
copythe MicrobeamManipulation to copy.

Member Function Documentation

◆ addLightSourceSettings()

void ome::xml::model::MicrobeamManipulation::addLightSourceSettings ( std::shared_ptr< ome::xml::model::LightSourceSettings > &  lightSourceSettings)

Add LightSourceSettings.

Parameters
lightSourceSettingsthe LightSourceSettings to add.
Todo:

Return list position?

Detect and handle duplicates?

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ asXMLElementInternal()

void ome::xml::model::MicrobeamManipulation::asXMLElementInternal ( common::xml::dom::Document document,
common::xml::dom::Element element 
) const
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.

Concrete model object implementations should override this method.

Parameters
documentXML document for element creation.
elementXML 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().

◆ create()

std::shared_ptr< MicrobeamManipulation > ome::xml::model::MicrobeamManipulation::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a MicrobeamManipulation model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Returns
a new model object.

Referenced by ome::xml::model::Experiment::update().

+ Here is the caller graph for this function:

◆ elementName()

const std::string & ome::xml::model::MicrobeamManipulation::elementName ( ) const
virtual

Get the element name of this model object.

This will be the most-derived class name.

Returns
the element type.

Implements ome::xml::model::OMEModelObject.

◆ getDescription() [1/2]

std::shared_ptr< std::string > ome::xml::model::MicrobeamManipulation::getDescription ( )

Get the Description property.

Returns
the Description property.

References impl.

◆ getDescription() [2/2]

const std::shared_ptr< std::string > ome::xml::model::MicrobeamManipulation::getDescription ( ) const

Get the Description property.

Returns
the Description property.

References impl.

◆ getExperiment() [1/2]

std::weak_ptr< ome::xml::model::Experiment > ome::xml::model::MicrobeamManipulation::getExperiment ( )

Get the Experiment property.

Returns
the Experiment property.

References impl.

◆ getExperiment() [2/2]

const std::weak_ptr< ome::xml::model::Experiment > ome::xml::model::MicrobeamManipulation::getExperiment ( ) const

Get the Experiment property.

Returns
the Experiment property.

References impl.

◆ getID()

const std::string & ome::xml::model::MicrobeamManipulation::getID ( ) const

Get the ID property.

Returns
the ID property.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ getLightSourceSettings() [1/2]

std::shared_ptr< ome::xml::model::LightSourceSettings > & ome::xml::model::MicrobeamManipulation::getLightSourceSettings ( std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type  index)

Get LightSourceSettings.

Parameters
indexthe index number of the LightSourceSettings.
Returns
the LightSourceSettings.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLightSourceSettings() [2/2]

const std::shared_ptr< ome::xml::model::LightSourceSettings > & ome::xml::model::MicrobeamManipulation::getLightSourceSettings ( std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type  index) const

Get LightSourceSettings.

Parameters
indexthe index number of the LightSourceSettings.
Returns
the LightSourceSettings.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLightSourceSettingsList() [1/2]

std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > > & ome::xml::model::MicrobeamManipulation::getLightSourceSettingsList ( )

Get the LightSourceSettings list.

Returns
a reference to the list.

References impl.

◆ getLightSourceSettingsList() [2/2]

const std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > > & ome::xml::model::MicrobeamManipulation::getLightSourceSettingsList ( ) const

Get the LightSourceSettings list.

Returns
a reference to the list.

References impl.

◆ getLinkedExperimenter() [1/2]

std::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::MicrobeamManipulation::getLinkedExperimenter ( )

Get linked Experimenter.

Returns
the linked Experimenter. The pointer may be null.

References impl.

◆ getLinkedExperimenter() [2/2]

const std::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::MicrobeamManipulation::getLinkedExperimenter ( ) const

Get linked Experimenter.

Returns
the linked Experimenter. The pointer may be null.

References impl.

◆ getLinkedImage()

const std::weak_ptr< ome::xml::model::Image > & ome::xml::model::MicrobeamManipulation::getLinkedImage ( OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type  index) const

Get linked Image.

Parameters
indexthe index number of the Image.
Returns
a weak pointer to the Image.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedImageList()

OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type ome::xml::model::MicrobeamManipulation::getLinkedImageList ( ) const

Get the linked Image list.

Returns
a reference to the list.

References impl.

◆ getLinkedROI()

const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::MicrobeamManipulation::getLinkedROI ( OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type  index) const

Get linked ROI.

Parameters
indexthe index number of the ROI.
Returns
a weak pointer to the ROI.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedROIList()

OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type ome::xml::model::MicrobeamManipulation::getLinkedROIList ( ) const

Get the linked ROI list.

Returns
a reference to the list.

References impl.

◆ getType() [1/2]

std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > ome::xml::model::MicrobeamManipulation::getType ( )

Get the Type property.

Returns
the Type property.

References impl.

◆ getType() [2/2]

const std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > ome::xml::model::MicrobeamManipulation::getType ( ) const

Get the Type property.

Returns
the Type property.

References impl.

◆ getXMLNamespace()

const std::string & ome::xml::model::MicrobeamManipulation::getXMLNamespace ( ) const
virtual

Get the XML namespace for this model object.

Returns
the XML namespace.

Implements ome::xml::model::OMEModelObject.

Referenced by asXMLElementInternal().

+ Here is the caller graph for this function:

◆ link()

bool ome::xml::model::MicrobeamManipulation::link ( std::shared_ptr< Reference > &  reference,
std::shared_ptr< ome::xml::model::OMEModelObject > &  object 
)

Link a given OME model object to this model object.

Parameters
referencetype 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.
objectModel object to link to.
Returns
true if this model object was able to handle the reference, otherwise false.
Todo:
the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.
Todo:
This bit is silly; why do we have two dynamic_casts here.
Todo:
This bit is silly; why do we have two dynamic_casts here.

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.

◆ linkExperimenter()

void ome::xml::model::MicrobeamManipulation::linkExperimenter ( std::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Link Experimenter.

Parameters
experimenterthe Experimenter to link.

References impl.

◆ linkImage()

bool ome::xml::model::MicrobeamManipulation::linkImage ( const std::shared_ptr< ome::xml::model::Image > &  image_BackReference)

Link Image.

Parameters
image_BackReferencethe Image to link.
Returns
true if the object was added to the internal imageLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

Referenced by ome::xml::model::Image::link().

+ Here is the caller graph for this function:

◆ linkROI()

bool ome::xml::model::MicrobeamManipulation::linkROI ( const std::shared_ptr< ome::xml::model::ROI > &  roi)

Link ROI.

Parameters
roithe ROI to link.
Returns
true if the object was added to the internal roiLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

◆ removeLightSourceSettings()

void ome::xml::model::MicrobeamManipulation::removeLightSourceSettings ( std::shared_ptr< ome::xml::model::LightSourceSettings > &  lightSourceSettings)

Remove LightSourceSettings.

Parameters
lightSourceSettingsthe LightSourceSettings to remove.
Todo:

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ setDescription()

void ome::xml::model::MicrobeamManipulation::setDescription ( std::shared_ptr< std::string > &  description)

Set the Description property.

Parameters
descriptionthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setExperiment()

void ome::xml::model::MicrobeamManipulation::setExperiment ( std::weak_ptr< ome::xml::model::Experiment > &  experiment_BackReference)

Set the Experiment property.

Parameters
experiment_BackReferencethe value to set.

References impl.

◆ setID()

void ome::xml::model::MicrobeamManipulation::setID ( const std::string &  id)

Set the ID property.

Parameters
idthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setLightSourceSettings()

void ome::xml::model::MicrobeamManipulation::setLightSourceSettings ( std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings >>::size_type  index,
std::shared_ptr< ome::xml::model::LightSourceSettings > &  lightSourceSettings 
)

Set LightSourceSettings.

Parameters
indexthe index number of the LightSourceSettings.
lightSourceSettingsthe LightSourceSettings to set.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ setLinkedImage()

const std::weak_ptr< ome::xml::model::Image > & ome::xml::model::MicrobeamManipulation::setLinkedImage ( OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::Image > &  image_BackReference 
)

Set linked Image.

Note
The index must be valid.
Parameters
indexthe index number of the Image.
image_BackReferencethe Image to set.
Returns
a weak pointer to the Image.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ setLinkedROI()

const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::MicrobeamManipulation::setLinkedROI ( OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::ROI > &  roi 
)

Set linked ROI.

Note
The index must be valid.
Parameters
indexthe index number of the ROI.
roithe ROI to set.
Returns
a weak pointer to the ROI.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ setType()

void ome::xml::model::MicrobeamManipulation::setType ( std::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > &  type)

Set the Type property.

Parameters
typethe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ sizeOfLightSourceSettingsList()

std::vector< std::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type ome::xml::model::MicrobeamManipulation::sizeOfLightSourceSettingsList ( ) const

Get size of linked LightSourceSettings list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedImageList()

OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type ome::xml::model::MicrobeamManipulation::sizeOfLinkedImageList ( ) const

Get size of linked Image list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedROIList()

OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type ome::xml::model::MicrobeamManipulation::sizeOfLinkedROIList ( ) const

Get size of linked ROI list.

Returns
the size of the list.

References impl.

◆ unlinkExperimenter()

void ome::xml::model::MicrobeamManipulation::unlinkExperimenter ( std::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Unlink Experimenter.

Parameters
experimenterthe Experimenter to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.

References impl.

◆ unlinkImage()

bool ome::xml::model::MicrobeamManipulation::unlinkImage ( const std::shared_ptr< ome::xml::model::Image > &  image_BackReference)

Unlink Image.

Parameters
image_BackReferencethe Image to unlink.
Returns
true if the Image was unlinked, otherwise false if the Image was not linked and could hence not be unlinked.
Todo:

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.

◆ unlinkROI()

bool ome::xml::model::MicrobeamManipulation::unlinkROI ( const std::shared_ptr< ome::xml::model::ROI > &  roi)

Unlink ROI.

Parameters
roithe ROI to unlink.
Returns
true if the ROI was unlinked, otherwise false if the ROI was not linked and could hence not be unlinked.
Todo:

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.

◆ update()

void ome::xml::model::MicrobeamManipulation::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual

Update the object hierarchy recursively from an XML DOM tree.

Note
No properties are removed, only added or updated.
Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif 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::update(), and validElementName().

◆ validElementName()

bool ome::xml::model::MicrobeamManipulation::validElementName ( const std::string &  name) const
virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

Parameters
namethe element name to check.
Returns
true if valid, false if invalid.
Deprecated:
Always returns true since any element name is now regarded as being valid.

Implements ome::xml::model::detail::OMEModelObject.

Referenced by update().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: