com.inscoper.nbo.TIRFSettings¶

Represents the XML element TIRFSettings. More...

Inherits from com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	TIRFSettings()
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(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_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	setHILO(boolean value, boolean validate) Sets the value of the HILO attribute.
void	setHILO(boolean value) Sets the value of the HILO attribute.
boolean	getHILO() Returns the value of the HILO attribute.
void	resetHILO() Resets the HILO attribute to an unset state.
boolean	hasHILO() Checks whether the HILO attribute is present.
void	setTIRFAngle(float value, boolean validate) Sets the value of the TIRFAngle attribute.
void	setTIRFAngle(float value) Sets the value of the TIRFAngle attribute.
float	getTIRFAngle() Returns the value of the TIRFAngle attribute.
void	resetTIRFAngle() Resets the TIRFAngle attribute to an unset state.
boolean	hasTIRFAngle() Checks whether the TIRFAngle attribute is present.
void	setTIRFHardwareModuleRef_List(TIRFHardwareModuleRefVector value, boolean validate) Sets the list of TIRFHardwareModuleRef elements.
void	setTIRFHardwareModuleRef_List(TIRFHardwareModuleRefVector value) Sets the list of TIRFHardwareModuleRef elements.
TIRFHardwareModuleRefVector	getTIRFHardwareModuleRef_List() Returns the list of TIRFHardwareModuleRef elements.
void	addToTIRFHardwareModuleRef_List(TIRFHardwareModuleRef value, boolean validate) Adds a new TIRFHardwareModuleRef element to this object.
void	addToTIRFHardwareModuleRef_List(TIRFHardwareModuleRef value) Adds a new TIRFHardwareModuleRef element to this object.
void	clearTIRFHardwareModuleRef_List() Clear the list of TIRFHardwareModuleRef.
void	setTIRFLightPath(TIRFLightPath value, boolean validate) Sets the value of the TIRFLightPath element.
void	setTIRFLightPath(TIRFLightPath value) Sets the value of the TIRFLightPath element.
TIRFLightPath	getTIRFLightPath() Returns the value of the TIRFLightPath element.
void	resetTIRFLightPath() Resets the TIRFLightPath element to an unset state.
boolean	hasTIRFLightPath() Checks whether the optional TIRFLightPath element is present.
void	setDescription(Description value, boolean validate) Sets the value of the Description element.
void	setDescription(Description value) Sets the value of the Description element.
Description	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.
TIRFSettings	__internal_create(long cPtr, boolean own)
TIRFSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a TIRFSettings.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.TIRFSettings;

Represents the XML element TIRFSettings.

Total Internal Reflection Fluorescence (TIRF) microscopy is a modality in which fluorescence is excited in a thin layer by an evanescent wave produced by total internal reflection. This element defines the TIRF conditions that were used for this Experiment.

Public Functions Documentation¶

function delete¶

function TIRFSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.Settings_Type.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.

Reimplements: com.inscoper.nbo.Settings_Type.fromJsonFile

function fromJsonFile¶

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.

Reimplements: com.inscoper.nbo.Settings_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.Settings_Type.fromJsonString

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.

Reimplements: com.inscoper.nbo.Settings_Type.fromXmlFile

function fromXmlFile¶

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.

Reimplements: com.inscoper.nbo.Settings_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.Settings_Type.fromXmlString

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.

Reimplements: com.inscoper.nbo.Settings_Type.toXmlFile

function toXmlFile¶

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

Reimplements: com.inscoper.nbo.Settings_Type.toXmlString

function toXmlString¶

function setID¶

public void setID(
    LSID_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 component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setHILO¶

public void setHILO(
    boolean value,
    boolean validate
)

Sets the value of the HILO attribute.

Parameters:

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

This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).

function setHILO¶

public void setHILO(
    boolean value
)

Sets the value of the HILO attribute.

Parameters:

value The value to set

This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).

function getHILO¶

public boolean getHILO()

Returns the value of the HILO attribute.

Return: The value of the attribute

This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).

function resetHILO¶

public void resetHILO()

Resets the HILO attribute to an unset state.

This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).

function hasHILO¶

public boolean hasHILO()

Checks whether the HILO attribute is present.

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

This field capture whether (True) or not (False) TIRF illumination for this Experiment was set up at or below the critical angle (63˚; true TIRF) or with oblique illumination (i.e., Highly Inclined and Laminated Optical - HILO).

function setTIRFAngle¶

public void setTIRFAngle(
    float value,
    boolean validate
)

Sets the value of the TIRFAngle attribute.

Parameters:

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

This field captures the incidence Angle used in this case.

function setTIRFAngle¶

function getTIRFAngle¶

function resetTIRFAngle¶

function hasTIRFAngle¶

public boolean hasTIRFAngle()

Checks whether the TIRFAngle attribute is present.

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

This field captures the incidence Angle used in this case.

function setTIRFHardwareModuleRef_List¶

public void setTIRFHardwareModuleRef_List(
    TIRFHardwareModuleRefVector value,
    boolean validate
)

Sets the list of TIRFHardwareModuleRef elements.

Parameters:

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

No description available in the XSD standard.

function setTIRFHardwareModuleRef_List¶

public void setTIRFHardwareModuleRef_List(
    TIRFHardwareModuleRefVector value
)

Sets the list of TIRFHardwareModuleRef elements.

Parameters:

value The new list of TIRFHardwareModuleRef elements

No description available in the XSD standard.

function getTIRFHardwareModuleRef_List¶

public TIRFHardwareModuleRefVector getTIRFHardwareModuleRef_List()

Returns the list of TIRFHardwareModuleRef elements.

Return: The list of TIRFHardwareModuleRef elements

No description available in the XSD standard.

function addToTIRFHardwareModuleRef_List¶

public void addToTIRFHardwareModuleRef_List(
    TIRFHardwareModuleRef value,
    boolean validate
)

Adds a new TIRFHardwareModuleRef 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 addToTIRFHardwareModuleRef_List¶

public void addToTIRFHardwareModuleRef_List(
    TIRFHardwareModuleRef value
)

Adds a new TIRFHardwareModuleRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTIRFHardwareModuleRef_List¶

function setTIRFLightPath¶

public void setTIRFLightPath(
    TIRFLightPath value,
    boolean validate
)

Sets the value of the TIRFLightPath element.

Parameters:

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

No description available in the XSD standard.

function setTIRFLightPath¶

function getTIRFLightPath¶

function resetTIRFLightPath¶

function hasTIRFLightPath¶

public boolean hasTIRFLightPath()

Checks whether the optional TIRFLightPath element is present.

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

No description available in the XSD standard.

function setDescription¶

public void setDescription(
    Description value,
    boolean validate
)

Sets the value of the Description element.

Parameters:

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

No description available in the XSD standard.

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

public boolean hasDescription()

Checks whether the optional Description element is present.

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

No description available in the XSD standard.

function __internal_create¶

function fromBase¶

public static TIRFSettings fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a TIRFSettings.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.Settings_Type.fromBase

com.inscoper.nbo.TIRFSettings¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function TIRFSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setID¶

function setID¶

function getID¶

function resetID¶

function hasID¶

function setHILO¶

function setHILO¶

function getHILO¶

function resetHILO¶

function hasHILO¶

function setTIRFAngle¶

function setTIRFAngle¶

function getTIRFAngle¶

function resetTIRFAngle¶

function hasTIRFAngle¶

function setTIRFHardwareModuleRef_List¶

function setTIRFHardwareModuleRef_List¶

function getTIRFHardwareModuleRef_List¶

function addToTIRFHardwareModuleRef_List¶

function addToTIRFHardwareModuleRef_List¶

function clearTIRFHardwareModuleRef_List¶

function setTIRFLightPath¶

function setTIRFLightPath¶

function getTIRFLightPath¶

function resetTIRFLightPath¶

function hasTIRFLightPath¶

function setDescription¶

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function TIRFSettings¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶