Inscoper::NBO::ShutterSettings¶

Represents the XML element ShutterSettings. More...

#include <ShutterSettings.h>

Inherits from Inscoper::NBO::Settings_Type, Inscoper::NBO::Reference_Type, NBOBaseClass

Public Functions¶

	Name
	ShutterSettings()
	~ShutterSettings()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::OpticalApertureID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
OpticalApertureID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setOpenDuringZMovement(const bool & value, bool validate =true) Sets the value of the OpenDuringZMovement attribute.
bool	getOpenDuringZMovement() const Returns the value of the OpenDuringZMovement attribute.
void	resetOpenDuringZMovement() Resets the OpenDuringZMovement attribute to an unset state.
bool	hasOpenDuringZMovement() const Checks whether the OpenDuringZMovement attribute is present.
void	setApertureDiameter(const float & value, bool validate =true) Sets the value of the ApertureDiameter attribute.
float	getApertureDiameter() const Returns the value of the ApertureDiameter attribute.
void	resetApertureDiameter() Resets the ApertureDiameter attribute to an unset state.
bool	hasApertureDiameter() const Checks whether the ApertureDiameter attribute is present.
void	setApertureDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ApertureDiameterUnit attribute.
UnitsLength_TypePtr	getApertureDiameterUnit() const Returns the value of the ApertureDiameterUnit attribute.
void	resetApertureDiameterUnit() Resets the ApertureDiameterUnit attribute to an unset state.
bool	hasApertureDiameterUnit() const Checks whether the optional ApertureDiameterUnit attribute is present.
void	setMode(const Inscoper::NBO::ShutterMode_TypePtr & value, bool validate =true) Sets the value of the Mode attribute.
ShutterMode_TypePtr	getMode() const Returns the value of the Mode attribute.
void	resetMode() Resets the Mode attribute to an unset state.
bool	hasMode() const Checks whether the optional Mode attribute is present.
std::shared_ptr< ShutterSettings >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a ShutterSettings.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Settings_Type

	Name
	Settings_Type()
	~Settings_Type()
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class 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 ShutterSettings¶

function ~ShutterSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

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 fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

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 fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

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 fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

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 toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

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 toXmlString¶

std::string toXmlString(
    bool validate =true
) const

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 setID¶

void setID(
    const Inscoper::NBO::OpticalApertureID_TypePtr & value,
    bool validate =true
)

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 getID¶

function resetID¶

function hasID¶

bool hasID() const

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¶

void setOpenDuringZMovement(
    const bool & value,
    bool validate =true
)

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 getOpenDuringZMovement¶

bool getOpenDuringZMovement() const

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¶

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¶

bool hasOpenDuringZMovement() const

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¶

void setApertureDiameter(
    const float & value,
    bool validate =true
)

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 getApertureDiameter¶

float getApertureDiameter() const

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¶

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¶

bool hasApertureDiameter() const

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¶

void setApertureDiameterUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

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 getApertureDiameterUnit¶

function resetApertureDiameterUnit¶

function hasApertureDiameterUnit¶

bool hasApertureDiameterUnit() const

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¶

void setMode(
    const Inscoper::NBO::ShutterMode_TypePtr & value,
    bool validate =true
)

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 getMode¶

ShutterMode_TypePtr getMode() const

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¶

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¶

bool hasMode() const

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 fromBase¶

static std::shared_ptr< ShutterSettings > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a ShutterSettings.

Parameters:

base The base class to cast

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

Updated on 2026-09-23 at 16:50:39 +0200