Inscoper::NBO::MicrobeamManipulation¶

Represents the XML element MicrobeamManipulation. More...

#include <MicrobeamManipulation.h>

Inherits from NBOBaseClass

Public Classes¶

	Name
class	InlineAnnotationRef Represents the XML element AnnotationRef.
class	InlineDescription Represents the XML element Description.

Public Types¶

	Name
typedef std::shared_ptr< InlineDescription >	InlineDescriptionPtr
typedef std::shared_ptr< InlineAnnotationRef >	InlineAnnotationRefPtr

Public Functions¶

	Name
	MicrobeamManipulation()
	~MicrobeamManipulation()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::MicrobeamManipulationID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
MicrobeamManipulationID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setType(const Inscoper::NBO::MicrobeamManipulationType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
MicrobeamManipulationType_TypePtr	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the optional Type attribute is present.
void	setExperimenterRef_List(const std::vector< Inscoper::NBO::ExperimenterRefPtr > & value, bool validate =true) Sets the list of ExperimenterRef elements.
std::vector< Inscoper::NBO::ExperimenterRefPtr >	getExperimenterRef_List() const Returns the list of ExperimenterRef elements.
void	addToExperimenterRef_List(const Inscoper::NBO::ExperimenterRefPtr & value, bool validate =true) Adds a new ExperimenterRef element to this object.
void	clearExperimenterRef_List() Clear the list of ExperimenterRef.
void	setROIRef_List(const std::vector< Inscoper::NBO::ROIRefPtr > & value, bool validate =true) Sets the list of ROIRef elements.
std::vector< Inscoper::NBO::ROIRefPtr >	getROIRef_List() const Returns the list of ROIRef elements.
void	addToROIRef_List(const Inscoper::NBO::ROIRefPtr & value, bool validate =true) Adds a new ROIRef element to this object.
void	clearROIRef_List() Clear the list of ROIRef.
void	setLightSourceSettings_List(const std::vector< Inscoper::NBO::LightSourceSettingsPtr > & value, bool validate =true) Sets the list of LightSourceSettings elements.
std::vector< Inscoper::NBO::LightSourceSettingsPtr >	getLightSourceSettings_List() const Returns the list of LightSourceSettings elements.
void	addToLightSourceSettings_List(const Inscoper::NBO::LightSourceSettingsPtr & value, bool validate =true) Adds a new LightSourceSettings element to this object.
void	clearLightSourceSettings_List() Clear the list of LightSourceSettings.
void	setDescription(const Inscoper::NBO::MicrobeamManipulation::InlineDescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::MicrobeamManipulation::InlineDescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< MicrobeamManipulation >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a MicrobeamManipulation.

Detailed Description¶

class Inscoper::NBO::MicrobeamManipulation;

Represents the XML element MicrobeamManipulation.

Defines a microbeam operation and the region of the image it was applied to. The LightSourceSettingsRef element is a reference to the LightSourceSettings that were used in this case, including a reference to the light source that was used for this micromanipulation experiment (e.g....................... a laser used for photobleaching).

Public Types Documentation¶

typedef InlineDescriptionPtr¶

typedef InlineAnnotationRefPtr¶

Public Functions Documentation¶

function MicrobeamManipulation¶

function ~MicrobeamManipulation¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setID¶

void setID(
    const Inscoper::NBO::MicrobeamManipulationID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this MicrobeamManipulation hardware component.

function getID¶

function resetID¶

function hasID¶

bool hasID() const

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this MicrobeamManipulation hardware component.

function setType¶

void setType(
    const Inscoper::NBO::MicrobeamManipulationType_TypePtr & value,
    bool validate =true
)

Sets the value of the Type attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field defines the type of micromanipulation performed.

function getType¶

function resetType¶

function hasType¶

bool hasType() const

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field defines the type of micromanipulation performed.

function setExperimenterRef_List¶

void setExperimenterRef_List(
    const std::vector< Inscoper::NBO::ExperimenterRefPtr > & value,
    bool validate =true
)

Sets the list of ExperimenterRef elements.

Parameters:

value The new list of ExperimenterRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getExperimenterRef_List¶

std::vector< Inscoper::NBO::ExperimenterRefPtr > getExperimenterRef_List() const

Returns the list of ExperimenterRef elements.

Return: The list of ExperimenterRef elements

No description available in the XSD standard.

function addToExperimenterRef_List¶

void addToExperimenterRef_List(
    const Inscoper::NBO::ExperimenterRefPtr & value,
    bool validate =true
)

Adds a new ExperimenterRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearExperimenterRef_List¶

function setROIRef_List¶

void setROIRef_List(
    const std::vector< Inscoper::NBO::ROIRefPtr > & value,
    bool validate =true
)

Sets the list of ROIRef elements.

Parameters:

value The new list of ROIRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to the predefined four dimensional ROI (Region of Interest) that was used for this micromanipulation experiment.

function getROIRef_List¶

std::vector< Inscoper::NBO::ROIRefPtr > getROIRef_List() const

Returns the list of ROIRef elements.

Return: The list of ROIRef elements

This empty element refers to the predefined four dimensional ROI (Region of Interest) that was used for this micromanipulation experiment.

function addToROIRef_List¶

void addToROIRef_List(
    const Inscoper::NBO::ROIRefPtr & value,
    bool validate =true
)

Adds a new ROIRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This empty element refers to the predefined four dimensional ROI (Region of Interest) that was used for this micromanipulation experiment.

function clearROIRef_List¶

function setLightSourceSettings_List¶

void setLightSourceSettings_List(
    const std::vector< Inscoper::NBO::LightSourceSettingsPtr > & value,
    bool validate =true
)

Sets the list of LightSourceSettings elements.

Parameters:

value The new list of LightSourceSettings elements
validate If true, validates constraints on value. Default is true.

This holds a reference to the LightSource (i.e. the ID attribute) that was used in this case as well as the setting that were applied to in in this case.

function getLightSourceSettings_List¶

std::vector< Inscoper::NBO::LightSourceSettingsPtr > getLightSourceSettings_List() const

Returns the list of LightSourceSettings elements.

Return: The list of LightSourceSettings elements

This holds a reference to the LightSource (i.e. the ID attribute) that was used in this case as well as the setting that were applied to in in this case.

function addToLightSourceSettings_List¶

void addToLightSourceSettings_List(
    const Inscoper::NBO::LightSourceSettingsPtr & value,
    bool validate =true
)

Adds a new LightSourceSettings element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This holds a reference to the LightSource (i.e. the ID attribute) that was used in this case as well as the setting that were applied to in in this case.

function clearLightSourceSettings_List¶

void clearLightSourceSettings_List()

Clear the list of LightSourceSettings.

This holds a reference to the LightSource (i.e. the ID attribute) that was used in this case as well as the setting that were applied to in in this case.

function setDescription¶

void setDescription(
    const Inscoper::NBO::MicrobeamManipulation::InlineDescriptionPtr & value,
    bool validate =true
)

Sets the value of the Description element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A description for the Microbeam Manipulation. [plain-text multi-line string]

function getDescription¶

Inscoper::NBO::MicrobeamManipulation::InlineDescriptionPtr getDescription() const

Returns the value of the Description element.

Return: The value of the element

A description for the Microbeam Manipulation. [plain-text multi-line string]

function resetDescription¶

function hasDescription¶

bool hasDescription() const

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

A description for the Microbeam Manipulation. [plain-text multi-line string]

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr > & value,
    bool validate =true
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef_List¶

std::vector< Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

This is a simple multi-line comment or annotation describing this component.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::MicrobeamManipulation::InlineAnnotationRefPtr & value,
    bool validate =true
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function clearAnnotationRef_List¶

function fromBase¶

static std::shared_ptr< MicrobeamManipulation > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a MicrobeamManipulation.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:38 +0200