Inscoper::XYStage¶
XYStage class defines the interface for 2D-positioning devices. More...
#include <XYStage.h>
Inherits from Inscoper::AbstractSystem
Public Functions¶
| Name | |
|---|---|
| virtual | ~XYStage() =default Destructor. |
| virtual double | getXPosition() =0 Get the X-axis position. |
| virtual void | setXPosition(double x) =0 Set the X-axis position. |
| virtual void | checkXPosition() =0 Wait until the X-axis position is set. |
| virtual double | getXResolution() =0 Get the X-axis check function tolerance. |
| virtual void | setXResolution(double resolution) =0 Set the X-axis check function tolerance. |
| virtual double | getYPosition() =0 Get the Y-axis position. |
| virtual void | setYPosition(double y) =0 Set the Y-axis position. |
| virtual void | checkYPosition() =0 Wait until the Y axis position is set. |
| virtual double | getYResolution() =0 Get the axis check function tolerance. |
| virtual void | setYResolution(double resolution) =0 Set the axis check function tolerance. |
| virtual void | moveXYAxis() =0 Move both axes. |
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¶
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 ~XYStage¶
Destructor.
function getXPosition¶
Get the X-axis position.
Return: The X position
Retrieves the current position of the stage along the X-axis.
function setXPosition¶
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¶
Wait until the X-axis position is set.
Wait until the X-axis position is properly set, up to the tolerance level.
function 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¶
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¶
Get the Y-axis position.
Return: The Y position
Retrieves the current position of the stage along the Y-axis.
function setYPosition¶
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¶
Wait until the Y axis position is set.
Wait until the Y axis position is properly set, up to the tolerance level.
function 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¶
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¶
Move both axes.
Triggers the movement of the stage to the set X and Y positions.
Updated on 2026-09-03 at 12:14:17 +0200