com.inscoper.nbo.ShutterSettings

Represents the XML element ShutterSettings. More...

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

Public Functions

	Name
synchronized void	delete()
	ShutterSettings()
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(OpticalApertureID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(OpticalApertureID_Type value) Sets the value of the ID attribute.
OpticalApertureID_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	setOpenDuringZMovement(boolean value, boolean validate) Sets the value of the OpenDuringZMovement attribute.
void	setOpenDuringZMovement(boolean value) Sets the value of the OpenDuringZMovement attribute.
boolean	getOpenDuringZMovement() Returns the value of the OpenDuringZMovement attribute.
void	resetOpenDuringZMovement() Resets the OpenDuringZMovement attribute to an unset state.
boolean	hasOpenDuringZMovement() Checks whether the OpenDuringZMovement attribute is present.
void	setApertureDiameter(float value, boolean validate) Sets the value of the ApertureDiameter attribute.
void	setApertureDiameter(float value) Sets the value of the ApertureDiameter attribute.
float	getApertureDiameter() Returns the value of the ApertureDiameter attribute.
void	resetApertureDiameter() Resets the ApertureDiameter attribute to an unset state.
boolean	hasApertureDiameter() Checks whether the ApertureDiameter attribute is present.
void	setApertureDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the ApertureDiameterUnit attribute.
void	setApertureDiameterUnit(UnitsLength_Type value) Sets the value of the ApertureDiameterUnit attribute.
UnitsLength_Type	getApertureDiameterUnit() Returns the value of the ApertureDiameterUnit attribute.
void	resetApertureDiameterUnit() Resets the ApertureDiameterUnit attribute to an unset state.
boolean	hasApertureDiameterUnit() Checks whether the optional ApertureDiameterUnit attribute is present.
void	setMode(ShutterMode_Type value, boolean validate) Sets the value of the Mode attribute.
void	setMode(ShutterMode_Type value) Sets the value of the Mode attribute.
ShutterMode_Type	getMode() Returns the value of the Mode attribute.
void	resetMode() Resets the Mode attribute to an unset state.
boolean	hasMode() Checks whether the optional Mode attribute is present.
ShutterSettings	__internal_create(long cPtr, boolean own)
ShutterSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions

	Name
	ShutterSettings(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ShutterSettings 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.ShutterSettings;

Represents the XML element ShutterSettings.

This element holds the Setting applied to a Shutter used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Shutter in question.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.Settings_Type.delete

function ShutterSettings

public ShutterSettings()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Settings_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Settings_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Settings_Type.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.Settings_Type.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

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

Reimplements: com.inscoper.nbo.Settings_Type.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

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

Reimplements: com.inscoper.nbo.Settings_Type.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

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

Reimplements: com.inscoper.nbo.Settings_Type.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

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.Settings_Type.toXmlString

function setID

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

This is the Unique Identifier of the device used in this case.

function setID

public void setID(
    OpticalApertureID_Type value
)

Sets the value of the ID attribute.

Parameters:

• value The value to set

This is the Unique Identifier of the device used in this case.

function getID

public OpticalApertureID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

This is the Unique Identifier of the device used in this case.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

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

This is the Unique Identifier of the device used in this case.

function setOpenDuringZMovement

public void setOpenDuringZMovement(
    boolean value,
    boolean validate
)

Sets the value of the OpenDuringZMovement attribute.

Parameters:

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

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

function setOpenDuringZMovement

public void setOpenDuringZMovement(
    boolean value
)

Sets the value of the OpenDuringZMovement attribute.

Parameters:

• value The value to set

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

function getOpenDuringZMovement

public boolean getOpenDuringZMovement()

Returns the value of the OpenDuringZMovement attribute.

Return: The value of the attribute

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

function resetOpenDuringZMovement

public void resetOpenDuringZMovement()

Resets the OpenDuringZMovement attribute to an unset state.

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

function hasOpenDuringZMovement

public boolean hasOpenDuringZMovement()

Checks whether the OpenDuringZMovement attribute is present.

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

This field captures whether this Shutter was open (True) or closed (False) during Z-movement between successive Z-planes in this Image.

function setApertureDiameter

public void setApertureDiameter(
    float value,
    boolean validate
)

Sets the value of the ApertureDiameter attribute.

Parameters:

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

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

function setApertureDiameter

public void setApertureDiameter(
    float value
)

Sets the value of the ApertureDiameter attribute.

Parameters:

• value The value to set

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

function getApertureDiameter

public float getApertureDiameter()

Returns the value of the ApertureDiameter attribute.

Return: The value of the attribute

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

function resetApertureDiameter

public void resetApertureDiameter()

Resets the ApertureDiameter attribute to an unset state.

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

function hasApertureDiameter

public boolean hasApertureDiameter()

Checks whether the ApertureDiameter attribute is present.

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

This field records the actual physical Aperture Diameter that was used for this Shutter during the Acquisition of this Channel.

function setApertureDiameterUnit

public void setApertureDiameterUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the ApertureDiameterUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setApertureDiameterUnit

public void setApertureDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the ApertureDiameterUnit attribute.

Parameters:

• value The value to set

No description available in the XSD standard.

function getApertureDiameterUnit

public UnitsLength_Type getApertureDiameterUnit()

Returns the value of the ApertureDiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetApertureDiameterUnit

public void resetApertureDiameterUnit()

Resets the ApertureDiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasApertureDiameterUnit

public boolean hasApertureDiameterUnit()

Checks whether the optional ApertureDiameterUnit attribute is present.

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

No description available in the XSD standard.

function setMode

public void setMode(
    ShutterMode_Type value,
    boolean validate
)

Sets the value of the Mode attribute.

Parameters:

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

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function setMode

public void setMode(
    ShutterMode_Type value
)

Sets the value of the Mode attribute.

Parameters:

• value The value to set

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function getMode

public ShutterMode_Type getMode()

Returns the value of the Mode attribute.

Return: The value of the attribute

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function resetMode

public void resetMode()

Resets the Mode attribute to an unset state.

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function hasMode

public boolean hasMode()

Checks whether the optional Mode attribute is present.

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

This field records the operation mode that was applied to this Shutter during the Acquisition of this Channel. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function __internal_create

public static ShutterSettings __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.__internal_create

function fromBase

public static ShutterSettings fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

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

Reimplements: com.inscoper.nbo.Settings_Type.fromBase

Protected Functions Documentation

function ShutterSettings

protected ShutterSettings(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.Settings_Type.finalize

function getCPtr

protected static long getCPtr(
    ShutterSettings obj
)

---

Updated on 2026-06-22 at 17:06:32 +0200