com.inscoper.api.XYStage¶

XYStage class defines the interface for 2D-positioning devices. More...

Inherits from com.inscoper.api.AbstractSystem

Public Functions¶

	Name
synchronized void	delete()
double	getXPosition() Get the X-axis position.
void	setXPosition(double x) Set the X-axis position.
void	checkXPosition() Wait until the X-axis position is set.
double	getXResolution() Get the X-axis check function tolerance.
void	setXResolution(double resolution) Set the X-axis check function tolerance.
double	getYPosition() Get the Y-axis position.
void	setYPosition(double y) Set the Y-axis position.
void	checkYPosition() Wait until the Y axis position is set.
double	getYResolution() Get the axis check function tolerance.
void	setYResolution(double resolution) Set the axis check function tolerance.
void	moveXYAxis() Move both axes.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.api.AbstractSystem

	Name
EDeviceType	getDeviceType() Get the type of the device.
String	getLastError() Get the last error message.
StringVector	getProperties() Get the list of available properties.
SubDeviceIdVector	getModifiedProperties() Get the list of modified properties.
String	getProperty(String name) Get the value of a property.
void	setProperty(String name, String value) Set the value of a property.
void	checkProperty(String name) Check if a property value is valid.
boolean	isReadOnly(String propName) Check if a property is read-only.
EParamType	getType(String propName) Get the data type of a property.
String	getMin(String propName) Get the minimum value of a property.
String	getMax(String propName) Get the maximum value of a property.
String	getStep(String propName) Get the step size of a property.
StringVector	getValueList(String propName) Get the list of allowed values for a property.
boolean	isAccessibleInSequence(String propName) Check if a property is accessible during sequence execution.
int	getRealType()
AbstractSystem	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.api.AbstractSystem

	Name
	AbstractSystem(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.XYStage;

XYStage class defines the interface for 2D-positioning devices.

This class extends AbstractSystem to provide control of dual-axis positioning stages, enabling positioning in a 2D coordinate space.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.AbstractSystem.delete

function getXPosition¶

public double getXPosition()

Get the X-axis position.

Return: The X position

Retrieves the current position of the stage along the X-axis.

function setXPosition¶

public void setXPosition(
    double x
)

Set the X-axis position.

Parameters:

x : The X position to set

Moves the stage to the specified position along the X-axis.

function checkXPosition¶

public void checkXPosition()

Wait until the X-axis position is set.

Wait until the X-axis position is properly set, up to the tolerance level.

function getXResolution¶

public double getXResolution()

Get the X-axis check function tolerance.

Return: The tolerance

Retrieves the tolerance level of the check function of the stage X position.

function setXResolution¶

public void setXResolution(
    double resolution
)

Set the X-axis check function tolerance.

Parameters:

resolution : The tolerance to set

Sets the tolerance level of the check function of the stage X position.

function getYPosition¶

public double getYPosition()

Get the Y-axis position.

Return: The Y position

Retrieves the current position of the stage along the Y-axis.

function setYPosition¶

public void setYPosition(
    double y
)

Set the Y-axis position.

Parameters:

y : The Y position to set

Moves the stage to the specified position along the Y-axis.

function checkYPosition¶

public void checkYPosition()

Wait until the Y axis position is set.

Wait until the Y axis position is properly set, up to the tolerance level.

function getYResolution¶

public double getYResolution()

Get the axis check function tolerance.

Return: The Y tolerance

Retrieves the tolerance level of the check function of the stage Y position.

function setYResolution¶

public void setYResolution(
    double resolution
)

Set the axis check function tolerance.

Parameters:

resolution : The Y tolerance to set

Sets the tolerance level of the check function of the stage Y position.

function moveXYAxis¶

public void moveXYAxis()

Move both axes.

Triggers the movement of the stage to the set X and Y positions.

Protected Functions Documentation¶

function XYStage¶

protected XYStage(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.AbstractSystem.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.AbstractSystem.finalize

function getCPtr¶

protected static long getCPtr(
    XYStage obj
)

Updated on 2026-09-03 at 12:14:19 +0200