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, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(MicrobeamManipulationID_Type value, boolean validate) Sets the value of the ID attribute.
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, boolean validate) Sets the value of the Type attribute.
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, boolean validate) Sets the list of ExperimenterRef elements.
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, boolean validate) Adds a new ExperimenterRef element to this object.
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, boolean validate) Sets the list of ROIRef elements.
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, boolean validate) Adds a new ROIRef element to this object.
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, boolean validate) Sets the list of LightSourceSettings elements.
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, boolean validate) Adds a new LightSourceSettings element to this object.
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, boolean validate) Sets the value of the Description element.
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, boolean validate) Sets the list of AnnotationRef elements.
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, boolean validate) Adds a new AnnotationRef element to this object.
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)
MicrobeamManipulation	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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(
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

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 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,
    boolean validate
)

Sets the list of ROIRef elements.

Parameters:

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