com.inscoper.api.Stage

Stage class defines the interface for 1D-positioning devices. More...

Inherits from com.inscoper.api.AbstractSystem

Public Functions

	Name
synchronized void	delete()
double	getZPosition() Get the axis position.
void	setZPosition(double z) Set the axis position.
void	checkZPosition() Wait until the axis position is set.
double	getZResolution() Get the axis check function tolerance.
void	setZResolution(double resolution) Set the axis check function tolerance.

Protected Functions

	Name
	Stage(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Stage 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.Stage;

Stage class defines the interface for 1D-positioning devices.

This class extends AbstractSystem to provide control for single-axis positioning stages, typically used for Z-axis (focus) movement.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.api.AbstractSystem.delete

function getZPosition

public double getZPosition()

Get the axis position.

Return: The position

Retrieves the current position of the stage along the axis.

function setZPosition

public void setZPosition(
    double z
)

Set the axis position.

Parameters:

• z : The position to set

Moves the stage to the specified position along the axis.

function checkZPosition

public void checkZPosition()

Wait until the axis position is set.

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

function getZResolution

public double getZResolution()

Get the axis check function tolerance.

Return: The tolerance

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

function setZResolution

public void setZResolution(
    double resolution
)

Set the axis check function tolerance.

Parameters:

• resolution : The tolerance to set

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

Protected Functions Documentation

function Stage

protected Stage(
    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(
    Stage obj
)

---

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