MicrobeamManipulation

Bases: NBOBaseClass

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).

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
MicrobeamManipulation	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value, validate=True)

Sets the value of the ID attribute.

A Unique Identifier for this MicrobeamManipulation hardware component.

Parameters:

Name	Type	Description	Default
value	MicrobeamManipulationID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

A Unique Identifier for this MicrobeamManipulation hardware component.

Returns:

Type	Description
MicrobeamManipulationID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this MicrobeamManipulation hardware component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this MicrobeamManipulation hardware component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setType(value, validate=True)

Sets the value of the Type attribute.

This field defines the type of micromanipulation performed.

Parameters:

Name	Type	Description	Default
value	MicrobeamManipulationType_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getType()

Returns the value of the Type attribute.

This field defines the type of micromanipulation performed.

Returns:

Type	Description
MicrobeamManipulationType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field defines the type of micromanipulation performed.

hasType()

Checks whether the optional Type attribute is present.

This field defines the type of micromanipulation performed.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExperimenterRef_List(value, validate=True)

Sets the list of ExperimenterRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ExperimenterRef]	The new list of ExperimenterRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getExperimenterRef_List()

Returns the list of ExperimenterRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ExperimenterRef]	The list of ExperimenterRef elements

addToExperimenterRef_List(value, validate=True)

Adds a new ExperimenterRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearExperimenterRef_List()

Clear the list of ExperimenterRef.

No description available in the XSD standard.

setROIRef_List(value, validate=True)

Sets 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.

Parameters:

Name	Type	Description	Default
value	List[ROIRef]	The new list of ROIRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getROIRef_List()

Returns 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.

Returns:

Type	Description
List[ROIRef]	The list of ROIRef elements

addToROIRef_List(value, validate=True)

Adds a new ROIRef element to this object.

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

Parameters:

Name	Type	Description	Default
value	ROIRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearROIRef_List()

Clear the list of ROIRef.

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

setLightSourceSettings_List(value, validate=True)

Sets 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.

Parameters:

Name	Type	Description	Default
value	List[LightSourceSettings]	The new list of LightSourceSettings elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getLightSourceSettings_List()

Returns 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.

Returns:

Type	Description
List[LightSourceSettings]	The list of LightSourceSettings elements

addToLightSourceSettings_List(value, validate=True)

Adds a new LightSourceSettings element to this object.

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.

Parameters:

Name	Type	Description	Default
value	LightSourceSettings	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

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.

setDescription(value, validate=True)

Sets the value of the Description element.

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

Parameters:

Name	Type	Description	Default
value	MicrobeamManipulation_InlineDescription	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDescription()

Returns the value of the Description element.

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

Returns:

Type	Description
MicrobeamManipulation_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

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

hasDescription()

Checks whether the optional Description element is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

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

Parameters:

Name	Type	Description	Default
value	List[MicrobeamManipulation_InlineAnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

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

Returns:

Type	Description
List[MicrobeamManipulation_InlineAnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

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

Parameters:

Name	Type	Description	Default
value	MicrobeamManipulation_InlineAnnotationRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearAnnotationRef_List()

Clear the list of AnnotationRef.

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