com.inscoper.nbo.MicrobeamManipulation

Represents the XML element MicrobeamManipulation. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	MicrobeamManipulation()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(MicrobeamManipulationID_Type value) Sets the value of the ID attribute.
MicrobeamManipulationID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setType(MicrobeamManipulationType_Type value) Sets the value of the Type attribute.
MicrobeamManipulationType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setExperimenterRef_List(ExperimenterRefVector value) Sets the list of ExperimenterRef elements.
ExperimenterRefVector	getExperimenterRef_List() Returns the list of ExperimenterRef elements.
void	addToExperimenterRef_List(ExperimenterRef value) Adds a new ExperimenterRef element to this object.
void	clearExperimenterRef_List() Clear the list of ExperimenterRef.
void	setROIRef_List(ROIRefVector value) Sets the list of ROIRef elements.
ROIRefVector	getROIRef_List() Returns the list of ROIRef elements.
void	addToROIRef_List(ROIRef value) Adds a new ROIRef element to this object.
void	clearROIRef_List() Clear the list of ROIRef.
void	setLightSourceSettings_List(LightSourceSettingsVector value) Sets the list of LightSourceSettings elements.
LightSourceSettingsVector	getLightSourceSettings_List() Returns the list of LightSourceSettings elements.
void	addToLightSourceSettings_List(LightSourceSettings value) Adds a new LightSourceSettings element to this object.
void	clearLightSourceSettings_List() Clear the list of LightSourceSettings.
void	setDescription(MicrobeamManipulation_InlineDescription value) Sets the value of the Description element.
MicrobeamManipulation_InlineDescription	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setAnnotationRef_List(MicrobeamManipulation_InlineAnnotationRefVector value) Sets the list of AnnotationRef elements.
MicrobeamManipulation_InlineAnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(MicrobeamManipulation_InlineAnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
MicrobeamManipulation	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	MicrobeamManipulation(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(MicrobeamManipulation obj)

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.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 Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function MicrobeamManipulation

public MicrobeamManipulation()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

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

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    MicrobeamManipulationID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this MicrobeamManipulation hardware component.

function getID

public MicrobeamManipulationID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this MicrobeamManipulation hardware component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this MicrobeamManipulation hardware component.

function hasID

public boolean hasID()

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

public void setType(
    MicrobeamManipulationType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field defines the type of micromanipulation performed.

function getType

public MicrobeamManipulationType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field defines the type of micromanipulation performed.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

This field defines the type of micromanipulation performed.

function hasType

public boolean hasType()

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

public void setExperimenterRef_List(
    ExperimenterRefVector value
)

Sets the list of ExperimenterRef elements.

Parameters:

value The new list of ExperimenterRef elements

No description available in the XSD standard.

function getExperimenterRef_List

public ExperimenterRefVector getExperimenterRef_List()

Returns the list of ExperimenterRef elements.

Return: The list of ExperimenterRef elements

No description available in the XSD standard.

function addToExperimenterRef_List

public void addToExperimenterRef_List(
    ExperimenterRef value
)

Adds a new ExperimenterRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearExperimenterRef_List

public void clearExperimenterRef_List()

Clear the list of ExperimenterRef.

No description available in the XSD standard.

function setROIRef_List

public void setROIRef_List(
    ROIRefVector value
)

Sets the list of ROIRef elements.

Parameters:

value The new 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 getROIRef_List

public ROIRefVector getROIRef_List()

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

public void addToROIRef_List(
    ROIRef value
)

Adds a new ROIRef element to this object.

Parameters:

value The element to add

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

function clearROIRef_List

public void 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.

function setLightSourceSettings_List

public void setLightSourceSettings_List(
    LightSourceSettingsVector value
)

Sets the list of LightSourceSettings elements.

Parameters:

value The new 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 getLightSourceSettings_List

public LightSourceSettingsVector getLightSourceSettings_List()

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

public void addToLightSourceSettings_List(
    LightSourceSettings value
)

Adds a new LightSourceSettings element to this object.

Parameters:

value The element to add

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

public 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

public void setDescription(
    MicrobeamManipulation_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

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

function getDescription

public MicrobeamManipulation_InlineDescription getDescription()

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

public void resetDescription()

Resets the Description element to an unset state.

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

function hasDescription

public boolean hasDescription()

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

public void setAnnotationRef_List(
    MicrobeamManipulation_InlineAnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

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

function getAnnotationRef_List

public MicrobeamManipulation_InlineAnnotationRefVector getAnnotationRef_List()

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

public void addToAnnotationRef_List(
    MicrobeamManipulation_InlineAnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

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

function clearAnnotationRef_List

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

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

function __internal_create

public static MicrobeamManipulation __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function MicrobeamManipulation

protected MicrobeamManipulation(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    MicrobeamManipulation obj
)

Updated on 2026-02-13 at 16:11:04 +0100