com.inscoper.nbo.ConfocalScanner_Type¶

Represents the XML complex type ConfocalScanner. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.RasterScanner, com.inscoper.nbo.SpinningDisk

Public Functions¶

	Name
synchronized void	delete()
	ConfocalScanner_Type()
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(ConfocalScannerID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ConfocalScannerID_Type value) Sets the value of the ID attribute.
ConfocalScannerID_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	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setNrOfScanPoints(int value, boolean validate) Sets the value of the NrOfScanPoints attribute.
void	setNrOfScanPoints(int value) Sets the value of the NrOfScanPoints attribute.
int	getNrOfScanPoints() Returns the value of the NrOfScanPoints attribute.
void	resetNrOfScanPoints() Resets the NrOfScanPoints attribute to an unset state.
boolean	hasNrOfScanPoints() Checks whether the NrOfScanPoints attribute is present.
void	setMaxFrameRate(float value, boolean validate) Sets the value of the MaxFrameRate attribute.
void	setMaxFrameRate(float value) Sets the value of the MaxFrameRate attribute.
float	getMaxFrameRate() Returns the value of the MaxFrameRate attribute.
void	resetMaxFrameRate() Resets the MaxFrameRate attribute to an unset state.
boolean	hasMaxFrameRate() Checks whether the MaxFrameRate attribute is present.
void	setMaxFrameRateUnit(UnitsFrequency_Type value, boolean validate) Sets the value of the MaxFrameRateUnit attribute.
void	setMaxFrameRateUnit(UnitsFrequency_Type value) Sets the value of the MaxFrameRateUnit attribute.
UnitsFrequency_Type	getMaxFrameRateUnit() Returns the value of the MaxFrameRateUnit attribute.
void	resetMaxFrameRateUnit() Resets the MaxFrameRateUnit attribute to an unset state.
boolean	hasMaxFrameRateUnit() Checks whether the optional MaxFrameRateUnit attribute is present.
void	setPointsConfiguration(String value, boolean validate) Sets the value of the PointsConfiguration attribute.
void	setPointsConfiguration(String value) Sets the value of the PointsConfiguration attribute.
String	getPointsConfiguration() Returns the value of the PointsConfiguration attribute.
void	resetPointsConfiguration() Resets the PointsConfiguration attribute to an unset state.
boolean	hasPointsConfiguration() Checks whether the PointsConfiguration attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
ConfocalScanner_Type	__internal_create(long cPtr, boolean own)
ConfocalScanner_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a ConfocalScanner_Type.
StringSet	getPointsConfigurationAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	ConfocalScanner_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ConfocalScanner_Type obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.ConfocalScanner_Type;

Represents the XML complex type ConfocalScanner.

According to ISO-10934-2-2007, a confocal microscope is a microscope in which, ideally, a point in the object plane is illuminated by a diffraction-limited spot of light, and light emanating from this point is focused upon and detected from an area smaller than the central area of the diffraction disc. The confocal principle leads to improved axial resolution by suppression of light from out-of-focus planes. In order to utilize this modality, a Confocal Scanner is used to form an Image of an extended Specimen region by controlling the direction of an outgoing Laser beam, the position of the Specimen or the location of the illuminated and detected spots simultaneously. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Public Functions Documentation¶

function delete¶

function ConfocalScanner_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

Reimplemented by: com.inscoper.nbo.RasterScanner.getTypeName, com.inscoper.nbo.SpinningDisk.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

Reimplemented by: com.inscoper.nbo.RasterScanner.getXMLName, com.inscoper.nbo.SpinningDisk.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

Reimplemented by: com.inscoper.nbo.RasterScanner.getNBOType, com.inscoper.nbo.SpinningDisk.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.NBOBaseClass.getChildren

Reimplemented by: com.inscoper.nbo.RasterScanner.getChildren, com.inscoper.nbo.SpinningDisk.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.NBOBaseClass.getSubElements

Reimplemented by: com.inscoper.nbo.RasterScanner.getSubElements, com.inscoper.nbo.SpinningDisk.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.

Reimplemented by: com.inscoper.nbo.RasterScanner.fromJsonFile, com.inscoper.nbo.SpinningDisk.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplemented by: com.inscoper.nbo.RasterScanner.fromJsonFile, com.inscoper.nbo.SpinningDisk.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.

Reimplemented by: com.inscoper.nbo.RasterScanner.fromJsonString, com.inscoper.nbo.SpinningDisk.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

Reimplemented by: com.inscoper.nbo.RasterScanner.fromJsonString, com.inscoper.nbo.SpinningDisk.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.

Reimplemented by: com.inscoper.nbo.RasterScanner.fromXmlFile, com.inscoper.nbo.SpinningDisk.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplemented by: com.inscoper.nbo.RasterScanner.fromXmlFile, com.inscoper.nbo.SpinningDisk.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.

Reimplemented by: com.inscoper.nbo.RasterScanner.fromXmlString, com.inscoper.nbo.SpinningDisk.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

Reimplemented by: com.inscoper.nbo.RasterScanner.fromXmlString, com.inscoper.nbo.SpinningDisk.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.

Reimplemented by: com.inscoper.nbo.RasterScanner.toXmlFile, com.inscoper.nbo.SpinningDisk.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplemented by: com.inscoper.nbo.RasterScanner.toXmlFile, com.inscoper.nbo.SpinningDisk.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

Reimplemented by: com.inscoper.nbo.RasterScanner.toXmlString, com.inscoper.nbo.SpinningDisk.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplemented by: com.inscoper.nbo.RasterScanner.toXmlString, com.inscoper.nbo.SpinningDisk.toXmlString

function setID¶

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

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this component.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setNrOfScanPoints¶

public void setNrOfScanPoints(
    int value,
    boolean validate
)

Sets the value of the NrOfScanPoints attribute.

Parameters:

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

This field records the number of scanning points available for this scan head.

function setNrOfScanPoints¶

public void setNrOfScanPoints(
    int value
)

Sets the value of the NrOfScanPoints attribute.

Parameters:

value The value to set

This field records the number of scanning points available for this scan head.

function getNrOfScanPoints¶

public int getNrOfScanPoints()

Returns the value of the NrOfScanPoints attribute.

Return: The value of the attribute

This field records the number of scanning points available for this scan head.

function resetNrOfScanPoints¶

function hasNrOfScanPoints¶

public boolean hasNrOfScanPoints()

Checks whether the NrOfScanPoints attribute is present.

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

This field records the number of scanning points available for this scan head.

function setMaxFrameRate¶

public void setMaxFrameRate(
    float value,
    boolean validate
)

Sets the value of the MaxFrameRate attribute.

Parameters:

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

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

function setMaxFrameRate¶

public void setMaxFrameRate(
    float value
)

Sets the value of the MaxFrameRate attribute.

Parameters:

value The value to set

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

function getMaxFrameRate¶

public float getMaxFrameRate()

Returns the value of the MaxFrameRate attribute.

Return: The value of the attribute

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

function resetMaxFrameRate¶

function hasMaxFrameRate¶

public boolean hasMaxFrameRate()

Checks whether the MaxFrameRate attribute is present.

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

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

function setMaxFrameRateUnit¶

public void setMaxFrameRateUnit(
    UnitsFrequency_Type value,
    boolean validate
)

Sets the value of the MaxFrameRateUnit 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 setMaxFrameRateUnit¶

public void setMaxFrameRateUnit(
    UnitsFrequency_Type value
)

Sets the value of the MaxFrameRateUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMaxFrameRateUnit¶

function resetMaxFrameRateUnit¶

function hasMaxFrameRateUnit¶

public boolean hasMaxFrameRateUnit()

Checks whether the optional MaxFrameRateUnit attribute is present.

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

No description available in the XSD standard.

function setPointsConfiguration¶

public void setPointsConfiguration(
    String value,
    boolean validate
)

Sets the value of the PointsConfiguration attribute.

Parameters:

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

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

function setPointsConfiguration¶

public void setPointsConfiguration(
    String value
)

Sets the value of the PointsConfiguration attribute.

Parameters:

value The value to set

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

function getPointsConfiguration¶

public String getPointsConfiguration()

Returns the value of the PointsConfiguration attribute.

Return: The value of the attribute

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

function resetPointsConfiguration¶

public void resetPointsConfiguration()

Resets the PointsConfiguration attribute to an unset state.

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

function hasPointsConfiguration¶

public boolean hasPointsConfiguration()

Checks whether the PointsConfiguration attribute is present.

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

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value,
    boolean validate
)

Sets the value of the AnnotationRef 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 setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

No description available in the XSD standard.

function __internal_create¶

public static ConfocalScanner_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Reimplemented by: com.inscoper.nbo.RasterScanner.__internal_create, com.inscoper.nbo.SpinningDisk.__internal_create

function fromBase¶

public static ConfocalScanner_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a ConfocalScanner_Type.

Parameters:

base The base class to cast

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

Reimplemented by: com.inscoper.nbo.RasterScanner.fromBase, com.inscoper.nbo.SpinningDisk.fromBase

function getPointsConfigurationAllowedValues¶

public static StringSet getPointsConfigurationAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

Protected Functions Documentation¶

function ConfocalScanner_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.RasterScanner.swigSetCMemOwn, com.inscoper.nbo.SpinningDisk.swigSetCMemOwn

com.inscoper.nbo.ConfocalScanner_Type¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function ConfocalScanner_Type¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setID¶

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

function setName¶

function getName¶

function resetName¶

function hasName¶

function setNrOfScanPoints¶

function setNrOfScanPoints¶

function getNrOfScanPoints¶

function resetNrOfScanPoints¶

function hasNrOfScanPoints¶

function setMaxFrameRate¶

function setMaxFrameRate¶

function getMaxFrameRate¶

function resetMaxFrameRate¶

function hasMaxFrameRate¶

function setMaxFrameRateUnit¶

function setMaxFrameRateUnit¶

function getMaxFrameRateUnit¶

function resetMaxFrameRateUnit¶

function hasMaxFrameRateUnit¶

function setPointsConfiguration¶

function setPointsConfiguration¶

function getPointsConfiguration¶

function resetPointsConfiguration¶

function hasPointsConfiguration¶

function setAnnotationRef¶

function setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

function __internal_create¶

function fromBase¶

function getPointsConfigurationAllowedValues¶

Protected Functions Documentation¶

function ConfocalScanner_Type¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶