com.inscoper.nbo.RasterScanner¶

Represents the XML element RasterScanner. More...

Inherits from com.inscoper.nbo.ConfocalScanner_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	RasterScanner()
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	setType(RasterScannerType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(RasterScannerType_Type value) Sets the value of the Type attribute.
RasterScannerType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setHorizontalScanningSpeed(float value, boolean validate) Sets the value of the HorizontalScanningSpeed attribute.
void	setHorizontalScanningSpeed(float value) Sets the value of the HorizontalScanningSpeed attribute.
float	getHorizontalScanningSpeed() Returns the value of the HorizontalScanningSpeed attribute.
void	resetHorizontalScanningSpeed() Resets the HorizontalScanningSpeed attribute to an unset state.
boolean	hasHorizontalScanningSpeed() Checks whether the HorizontalScanningSpeed attribute is present.
void	setHorizontalScanningSpeedUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the HorizontalScanningSpeedUnit attribute.
void	setHorizontalScanningSpeedUnit(UnitsVelocity_Type value) Sets the value of the HorizontalScanningSpeedUnit attribute.
UnitsVelocity_Type	getHorizontalScanningSpeedUnit() Returns the value of the HorizontalScanningSpeedUnit attribute.
void	resetHorizontalScanningSpeedUnit() Resets the HorizontalScanningSpeedUnit attribute to an unset state.
boolean	hasHorizontalScanningSpeedUnit() Checks whether the optional HorizontalScanningSpeedUnit attribute is present.
void	setVerticalScanningSpeed(float value, boolean validate) Sets the value of the VerticalScanningSpeed attribute.
void	setVerticalScanningSpeed(float value) Sets the value of the VerticalScanningSpeed attribute.
float	getVerticalScanningSpeed() Returns the value of the VerticalScanningSpeed attribute.
void	resetVerticalScanningSpeed() Resets the VerticalScanningSpeed attribute to an unset state.
boolean	hasVerticalScanningSpeed() Checks whether the VerticalScanningSpeed attribute is present.
void	setVerticalScanningSpeedUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the VerticalScanningSpeedUnit attribute.
void	setVerticalScanningSpeedUnit(UnitsVelocity_Type value) Sets the value of the VerticalScanningSpeedUnit attribute.
UnitsVelocity_Type	getVerticalScanningSpeedUnit() Returns the value of the VerticalScanningSpeedUnit attribute.
void	resetVerticalScanningSpeedUnit() Resets the VerticalScanningSpeedUnit attribute to an unset state.
boolean	hasVerticalScanningSpeedUnit() Checks whether the optional VerticalScanningSpeedUnit attribute is present.
RasterScanner	__internal_create(long cPtr, boolean own)
RasterScanner	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a RasterScanner.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type()
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.
StringSet	getPointsConfigurationAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.RasterScanner;

Represents the XML element RasterScanner.

A Raster Scanner is typically used for systematic periodic scanning (raster scanning) of the Laser beam or of the Specimen position, either in one or in two dimensions. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Public Functions Documentation¶

function delete¶

function RasterScanner¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.ConfocalScanner_Type.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.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonFile

function 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.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.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

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.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.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlFile

function 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.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.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

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.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.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.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

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlString

function setType¶

public void setType(
    RasterScannerType_Type value,
    boolean validate
)

Sets the value of the Type attribute.

Parameters:

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

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function setType¶

public void setType(
    RasterScannerType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function getType¶

public RasterScannerType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function resetType¶

public void resetType()

Resets the Type attribute to an unset state.

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function hasType¶

public boolean hasType()

Checks whether the optional Type attribute is present.

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

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function setHorizontalScanningSpeed¶

public void setHorizontalScanningSpeed(
    float value,
    boolean validate
)

Sets the value of the HorizontalScanningSpeed attribute.

Parameters:

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

This field records the maximal Horizontal Scanning Speed of this device.

function setHorizontalScanningSpeed¶

public void setHorizontalScanningSpeed(
    float value
)

Sets the value of the HorizontalScanningSpeed attribute.

Parameters:

value The value to set

This field records the maximal Horizontal Scanning Speed of this device.

function getHorizontalScanningSpeed¶

public float getHorizontalScanningSpeed()

Returns the value of the HorizontalScanningSpeed attribute.

Return: The value of the attribute

This field records the maximal Horizontal Scanning Speed of this device.

function resetHorizontalScanningSpeed¶

function hasHorizontalScanningSpeed¶

public boolean hasHorizontalScanningSpeed()

Checks whether the HorizontalScanningSpeed attribute is present.

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

This field records the maximal Horizontal Scanning Speed of this device.

function setHorizontalScanningSpeedUnit¶

public void setHorizontalScanningSpeedUnit(
    UnitsVelocity_Type value,
    boolean validate
)

Sets the value of the HorizontalScanningSpeedUnit 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 setHorizontalScanningSpeedUnit¶

public void setHorizontalScanningSpeedUnit(
    UnitsVelocity_Type value
)

Sets the value of the HorizontalScanningSpeedUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getHorizontalScanningSpeedUnit¶

public UnitsVelocity_Type getHorizontalScanningSpeedUnit()

Returns the value of the HorizontalScanningSpeedUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetHorizontalScanningSpeedUnit¶

function hasHorizontalScanningSpeedUnit¶

public boolean hasHorizontalScanningSpeedUnit()

Checks whether the optional HorizontalScanningSpeedUnit attribute is present.

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

No description available in the XSD standard.

function setVerticalScanningSpeed¶

public void setVerticalScanningSpeed(
    float value,
    boolean validate
)

Sets the value of the VerticalScanningSpeed attribute.

Parameters:

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

This field records the maximal Vertical Scanning Speed of this device.

function setVerticalScanningSpeed¶

public void setVerticalScanningSpeed(
    float value
)

Sets the value of the VerticalScanningSpeed attribute.

Parameters:

value The value to set

This field records the maximal Vertical Scanning Speed of this device.

function getVerticalScanningSpeed¶

public float getVerticalScanningSpeed()

Returns the value of the VerticalScanningSpeed attribute.

Return: The value of the attribute

This field records the maximal Vertical Scanning Speed of this device.

function resetVerticalScanningSpeed¶

function hasVerticalScanningSpeed¶

public boolean hasVerticalScanningSpeed()

Checks whether the VerticalScanningSpeed attribute is present.

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

This field records the maximal Vertical Scanning Speed of this device.

function setVerticalScanningSpeedUnit¶

public void setVerticalScanningSpeedUnit(
    UnitsVelocity_Type value,
    boolean validate
)

Sets the value of the VerticalScanningSpeedUnit 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 setVerticalScanningSpeedUnit¶

public void setVerticalScanningSpeedUnit(
    UnitsVelocity_Type value
)

Sets the value of the VerticalScanningSpeedUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getVerticalScanningSpeedUnit¶

public UnitsVelocity_Type getVerticalScanningSpeedUnit()

Returns the value of the VerticalScanningSpeedUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetVerticalScanningSpeedUnit¶

function hasVerticalScanningSpeedUnit¶

public boolean hasVerticalScanningSpeedUnit()

Checks whether the optional VerticalScanningSpeedUnit attribute is present.

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

No description available in the XSD standard.

function __internal_create¶

function fromBase¶

public static RasterScanner fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a RasterScanner.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromBase

com.inscoper.nbo.RasterScanner¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function RasterScanner¶

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

function setType¶

function getType¶

function resetType¶

function hasType¶

function setHorizontalScanningSpeed¶

function setHorizontalScanningSpeed¶

function getHorizontalScanningSpeed¶

function resetHorizontalScanningSpeed¶

function hasHorizontalScanningSpeed¶

function setHorizontalScanningSpeedUnit¶

function setHorizontalScanningSpeedUnit¶

function getHorizontalScanningSpeedUnit¶

function resetHorizontalScanningSpeedUnit¶

function hasHorizontalScanningSpeedUnit¶

function setVerticalScanningSpeed¶

function setVerticalScanningSpeed¶

function getVerticalScanningSpeed¶

function resetVerticalScanningSpeed¶

function hasVerticalScanningSpeed¶

function setVerticalScanningSpeedUnit¶

function setVerticalScanningSpeedUnit¶

function getVerticalScanningSpeedUnit¶

function resetVerticalScanningSpeedUnit¶

function hasVerticalScanningSpeedUnit¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function RasterScanner¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶