Inscoper::NBO::TIRFSettings¶

Represents the XML element TIRFSettings. More...

#include <TIRFSettings.h>

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

Public Functions¶

	Name
	TIRFSettings()
	~TIRFSettings()
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::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	setHILO(const bool & value, bool validate =true) Sets the value of the HILO attribute.
bool	getHILO() const Returns the value of the HILO attribute.
void	resetHILO() Resets the HILO attribute to an unset state.
bool	hasHILO() const Checks whether the HILO attribute is present.
void	setTIRFAngle(const float & value, bool validate =true) Sets the value of the TIRFAngle attribute.
float	getTIRFAngle() const Returns the value of the TIRFAngle attribute.
void	resetTIRFAngle() Resets the TIRFAngle attribute to an unset state.
bool	hasTIRFAngle() const Checks whether the TIRFAngle attribute is present.
void	setTIRFHardwareModuleRef_List(const std::vector< Inscoper::NBO::TIRFHardwareModuleRefPtr > & value, bool validate =true) Sets the list of TIRFHardwareModuleRef elements.
std::vector< Inscoper::NBO::TIRFHardwareModuleRefPtr >	getTIRFHardwareModuleRef_List() const Returns the list of TIRFHardwareModuleRef elements.
void	addToTIRFHardwareModuleRef_List(const Inscoper::NBO::TIRFHardwareModuleRefPtr & value, bool validate =true) Adds a new TIRFHardwareModuleRef element to this object.
void	clearTIRFHardwareModuleRef_List() Clear the list of TIRFHardwareModuleRef.
void	setTIRFLightPath(const std::shared_ptr< Inscoper::NBO::TIRFLightPath > & value, bool validate =true) Sets the value of the TIRFLightPath element.
std::shared_ptr< Inscoper::NBO::TIRFLightPath >	getTIRFLightPath() const Returns the value of the TIRFLightPath element.
void	resetTIRFLightPath() Resets the TIRFLightPath element to an unset state.
bool	hasTIRFLightPath() const Checks whether the optional TIRFLightPath element is present.
void	setDescription(const Inscoper::NBO::DescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::DescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
std::shared_ptr< TIRFSettings >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a TIRFSettings.

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::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 TIRFSettings¶

function ~TIRFSettings¶

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::LSID_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.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setHILO¶

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

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

bool getHILO() const

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¶

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¶

bool hasHILO() const

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¶

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

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

function resetTIRFAngle¶

function hasTIRFAngle¶

bool hasTIRFAngle() const

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¶

void setTIRFHardwareModuleRef_List(
    const std::vector< Inscoper::NBO::TIRFHardwareModuleRefPtr > & value,
    bool validate =true
)

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

std::vector< Inscoper::NBO::TIRFHardwareModuleRefPtr > getTIRFHardwareModuleRef_List() const

Returns the list of TIRFHardwareModuleRef elements.

Return: The list of TIRFHardwareModuleRef elements

No description available in the XSD standard.

function addToTIRFHardwareModuleRef_List¶

void addToTIRFHardwareModuleRef_List(
    const Inscoper::NBO::TIRFHardwareModuleRefPtr & value,
    bool validate =true
)

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

function setTIRFLightPath¶

void setTIRFLightPath(
    const std::shared_ptr< Inscoper::NBO::TIRFLightPath > & value,
    bool validate =true
)

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

std::shared_ptr< Inscoper::NBO::TIRFLightPath > getTIRFLightPath() const

Returns the value of the TIRFLightPath element.

Return: The value of the element

No description available in the XSD standard.

function resetTIRFLightPath¶

function hasTIRFLightPath¶

bool hasTIRFLightPath() const

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¶

void setDescription(
    const Inscoper::NBO::DescriptionPtr & value,
    bool validate =true
)

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

function resetDescription¶

function hasDescription¶

bool hasDescription() const

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

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

Cast a NBOBaseClass to a TIRFSettings.

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