Inscoper::NBO::SpinningDisk¶

Represents the XML element SpinningDisk. More...

#include <SpinningDisk.h>

Inherits from Inscoper::NBO::ConfocalScanner_Type, NBOBaseClass

Public Functions¶

	Name
	SpinningDisk()
	~SpinningDisk()
virtual 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	setSingleDisk(const bool & value, bool validate =true) Sets the value of the SingleDisk attribute.
bool	getSingleDisk() const Returns the value of the SingleDisk attribute.
void	resetSingleDisk() Resets the SingleDisk attribute to an unset state.
bool	hasSingleDisk() const Checks whether the SingleDisk attribute is present.
void	setDiskSpeed(const float & value, bool validate =true) Sets the value of the DiskSpeed attribute.
float	getDiskSpeed() const Returns the value of the DiskSpeed attribute.
void	resetDiskSpeed() Resets the DiskSpeed attribute to an unset state.
bool	hasDiskSpeed() const Checks whether the DiskSpeed attribute is present.
void	setDiskSpeedUnit(const Inscoper::NBO::UnitsVelocity_TypePtr & value, bool validate =true) Sets the value of the DiskSpeedUnit attribute.
UnitsVelocity_TypePtr	getDiskSpeedUnit() const Returns the value of the DiskSpeedUnit attribute.
void	resetDiskSpeedUnit() Resets the DiskSpeedUnit attribute to an unset state.
bool	hasDiskSpeedUnit() const Checks whether the optional DiskSpeedUnit attribute is present.
std::shared_ptr< SpinningDisk >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a SpinningDisk.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::ConfocalScanner_Type

	Name
	ConfocalScanner_Type()
	~ConfocalScanner_Type()
void	setID(const Inscoper::NBO::ConfocalScannerID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ConfocalScannerID_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	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setNrOfScanPoints(const int & value, bool validate =true) Sets the value of the NrOfScanPoints attribute.
int	getNrOfScanPoints() const Returns the value of the NrOfScanPoints attribute.
void	resetNrOfScanPoints() Resets the NrOfScanPoints attribute to an unset state.
bool	hasNrOfScanPoints() const Checks whether the NrOfScanPoints attribute is present.
void	setMaxFrameRate(const float & value, bool validate =true) Sets the value of the MaxFrameRate attribute.
float	getMaxFrameRate() const Returns the value of the MaxFrameRate attribute.
void	resetMaxFrameRate() Resets the MaxFrameRate attribute to an unset state.
bool	hasMaxFrameRate() const Checks whether the MaxFrameRate attribute is present.
void	setMaxFrameRateUnit(const Inscoper::NBO::UnitsFrequency_TypePtr & value, bool validate =true) Sets the value of the MaxFrameRateUnit attribute.
UnitsFrequency_TypePtr	getMaxFrameRateUnit() const Returns the value of the MaxFrameRateUnit attribute.
void	resetMaxFrameRateUnit() Resets the MaxFrameRateUnit attribute to an unset state.
bool	hasMaxFrameRateUnit() const Checks whether the optional MaxFrameRateUnit attribute is present.
void	setPointsConfiguration(const std::string & value, bool validate =true) Sets the value of the PointsConfiguration attribute.
std::string	getPointsConfiguration() const Returns the value of the PointsConfiguration attribute.
void	resetPointsConfiguration() Resets the PointsConfiguration attribute to an unset state.
bool	hasPointsConfiguration() const Checks whether the PointsConfiguration attribute is present.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
const std::set< std::string > &	getPointsConfigurationAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::SpinningDisk;

Represents the XML element SpinningDisk.

A Spinning disk confocal scanner is a device in which the scanning of the illuminated and detected spots is performed simultaneously using an opaque disk called a Nipkow disk, which has many ideally identical small holes arranged in Archimedean spirals. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Public Functions Documentation¶

function SpinningDisk¶

function ~SpinningDisk¶

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

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

Sets the value of the SingleDisk attribute.

Parameters:

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

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function getSingleDisk¶

bool getSingleDisk() const

Returns the value of the SingleDisk attribute.

Return: The value of the attribute

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function resetSingleDisk¶

function hasSingleDisk¶

bool hasSingleDisk() const

Checks whether the SingleDisk attribute is present.

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

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function setDiskSpeed¶

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

Sets the value of the DiskSpeed attribute.

Parameters:

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

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function getDiskSpeed¶

float getDiskSpeed() const

Returns the value of the DiskSpeed attribute.

Return: The value of the attribute

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function resetDiskSpeed¶

function hasDiskSpeed¶

bool hasDiskSpeed() const

Checks whether the DiskSpeed attribute is present.

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

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function setDiskSpeedUnit¶

void setDiskSpeedUnit(
    const Inscoper::NBO::UnitsVelocity_TypePtr & value,
    bool validate =true
)

Sets the value of the DiskSpeedUnit 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 getDiskSpeedUnit¶

function resetDiskSpeedUnit¶

function hasDiskSpeedUnit¶

bool hasDiskSpeedUnit() const

Checks whether the optional DiskSpeedUnit attribute 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< SpinningDisk > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a SpinningDisk.

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