Inscoper::Stage

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

#include <Stage.h>

Inherits from Inscoper::AbstractSystem

Public Functions

	Name
virtual	~Stage() =default Destructor.
virtual double	getZPosition() =0 Get the axis position.
virtual void	setZPosition(double z) =0 Set the axis position.
virtual void	checkZPosition() =0 Wait until the axis position is set.
virtual double	getZResolution() =0 Get the axis check function tolerance.
virtual void	setZResolution(double resolution) =0 Set the axis check function tolerance.

Additional inherited members

Public Functions inherited from Inscoper::AbstractSystem

	Name
virtual	~AbstractSystem() =default Destructor.
virtual Inscoper::EDeviceType	getDeviceType() =0 Get the type of the device.
virtual std::string	getLastError() =0 Get the last error message.
virtual std::vector< std::string >	getProperties() =0 Get the list of available properties.
virtual std::vector< Inscoper::SubDeviceId >	getModifiedProperties() =0 Get the list of modified properties.
virtual std::string	getProperty(const std::string & name) =0 Get the value of a property.
virtual void	setProperty(const std::string & name, const std::string & value) =0 Set the value of a property.
virtual void	checkProperty(const std::string & name) =0 Check if a property value is valid.
virtual bool	isReadOnly(const std::string & propName) =0 Check if a property is read-only.
virtual Inscoper::EParamType	getType(const std::string & propName) =0 Get the data type of a property.
virtual std::string	getMin(const std::string & propName) =0 Get the minimum value of a property.
virtual std::string	getMax(const std::string & propName) =0 Get the maximum value of a property.
virtual std::string	getStep(const std::string & propName) =0 Get the step size of a property.
virtual std::vector< std::string >	getValueList(const std::string & propName) =0 Get the list of allowed values for a property.
virtual bool	isAccessibleInSequence(const std::string & propName) =0 Check if a property is accessible during sequence execution.

Detailed Description

class Inscoper::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 ~Stage

virtual ~Stage() =default

Destructor.

function getZPosition

virtual double getZPosition() =0

Get the axis position.

Return: The position

Retrieves the current position of the stage along the axis.

function setZPosition

virtual void setZPosition(
    double z
) =0

Set the axis position.

Parameters:

• z : The position to set

Moves the stage to the specified position along the axis.

function checkZPosition

virtual void checkZPosition() =0

Wait until the axis position is set.

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

function getZResolution

virtual double getZResolution() =0

Get the axis check function tolerance.

Return: The tolerance

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

function setZResolution

virtual void setZResolution(
    double resolution
) =0

Set the axis check function tolerance.

Parameters:

• resolution : The tolerance to set

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

---

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