Shutter

Bases: OpticalAperture_Type

Represents the XML element Shutter.

This element describes a Shutter available for this Instrument. Shutters are devices that open and close, and they may be mechanically or electro-mechanically controlled. Shutters are typically used to control the Light that raches the sample (i.e., to limit phototoxicity and photobleaching especially in case of live specimens), or the Detecrtor at any one time. They can also be used for Excitation or Emission Wavelength selection.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setResponseTime(value)

Sets the value of the ResponseTime attribute.

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getResponseTime()

Returns the value of the ResponseTime attribute.

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetResponseTime()

Resets the ResponseTime attribute to an unset state.

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

hasResponseTime()

Checks whether the optional ResponseTime attribute is present.

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

Returns:

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

setResponseTimeUnit(value)

Sets the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getResponseTimeUnit()

Returns the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetResponseTimeUnit()

Resets the ResponseTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasResponseTimeUnit()

Checks whether the optional ResponseTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setFunction(value)

Sets the value of the Function attribute.

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

Parameters:

Name	Type	Description	Default
value	ShutterFunction_Type	The value to set	required

getFunction()

Returns the value of the Function attribute.

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

Returns:

Type	Description
ShutterFunction_Type	The value of the attribute

resetFunction()

Resets the Function attribute to an unset state.

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

hasFunction()

Checks whether the optional Function attribute is present.

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

Returns:

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

setOperatingFrequency(value)

Sets the value of the OperatingFrequency attribute.

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getOperatingFrequency()

Returns the value of the OperatingFrequency attribute.

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

Returns:

Type	Description
float	The value of the attribute

resetOperatingFrequency()

Resets the OperatingFrequency attribute to an unset state.

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

hasOperatingFrequency()

Checks whether the optional OperatingFrequency attribute is present.

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

Returns:

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

setOperatingFrequencyUnit(value)

Sets the value of the OperatingFrequencyUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getOperatingFrequencyUnit()

Returns the value of the OperatingFrequencyUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetOperatingFrequencyUnit()

Resets the OperatingFrequencyUnit attribute to an unset state.

No description available in the XSD standard.

hasOperatingFrequencyUnit()

Checks whether the optional OperatingFrequencyUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMotorized(value)

Sets the value of the Motorized attribute.

This field describes whether this device is Motor (True) or Manually (False) operated.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getMotorized()

Returns the value of the Motorized attribute.

This field describes whether this device is Motor (True) or Manually (False) operated.

Returns:

Type	Description
boolean	The value of the attribute

resetMotorized()

Resets the Motorized attribute to an unset state.

This field describes whether this device is Motor (True) or Manually (False) operated.

hasMotorized()

Checks whether the optional Motorized attribute is present.

This field describes whether this device is Motor (True) or Manually (False) operated.

Returns:

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

setMaxApertureDiameter(value)

Sets the value of the MaxApertureDiameter attribute.

This field records the Maximum physical Diameter of the Aperture of this Shutter.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getMaxApertureDiameter()

Returns the value of the MaxApertureDiameter attribute.

This field records the Maximum physical Diameter of the Aperture of this Shutter.

Returns:

Type	Description
float	The value of the attribute

resetMaxApertureDiameter()

Resets the MaxApertureDiameter attribute to an unset state.

This field records the Maximum physical Diameter of the Aperture of this Shutter.

hasMaxApertureDiameter()

Checks whether the optional MaxApertureDiameter attribute is present.

This field records the Maximum physical Diameter of the Aperture of this Shutter.

Returns:

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

setMaxApertureDiameterUnit(value)

Sets the value of the MaxApertureDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getMaxApertureDiameterUnit()

Returns the value of the MaxApertureDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMaxApertureDiameterUnit()

Resets the MaxApertureDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasMaxApertureDiameterUnit()

Checks whether the optional MaxApertureDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMultimode(value)

Sets the value of the Multimode attribute.

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light 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).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getMultimode()

Returns the value of the Multimode attribute.

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light 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).

Returns:

Type	Description
boolean	The value of the attribute

resetMultimode()

Resets the Multimode attribute to an unset state.

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light 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).

hasMultimode()

Checks whether the optional Multimode attribute is present.

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light 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).

Returns:

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