magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse Class Reference

Inheritance diagram for magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse:

Collaboration diagram for magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse:

Public Member Functions
def	__init__ (self, kwargs)
def	on_activate (self)
	Initialisation performed during activation of the module.
def	on_deactivate (self)
	Deinitialisation performed during deactivation of the module.
def	get_constraints (self)
	Retrieve the hardware constrains from the magnet driving device. More...
def	move_rel (self, param_dict)
	Moves stage in given direction (relative movement) More...
def	move_abs (self, param_dict)
	Moves stage to absolute position (absolute movement) More...
def	abort (self)
	Stops movement of the stage. More...
def	get_pos (self, param_list=None)
	Gets current position of the stage. More...
def	get_status (self, param_list=None)
	Get the status of the position. More...
def	calibrate (self, param_list=None)
	Calibrates the stage. More...
def	get_velocity (self, param_list=None)
	Gets the current velocity for all connected axes. More...
def	set_velocity (self, param_dict=None)
	Write new value for velocity. More...
def	tell (self, param_dict=None)
	Send a command to the magnet. More...
def	ask (self, param_dict=None)
	Ask the magnet a question. More...
def	initialize (self)
def	set_magnet_idle_state (self, magnet_idle=True)
	Set the magnet to couple/decouple to/from the control. More...
def	get_magnet_idle_state (self)
	Retrieve the current state of the magnet, whether it is idle or not. More...

Static Public Attributes
	motorstage_xyz = Connector(interface='MotorInterface')
	motorstage_rot = Connector(interface='MotorInterface')

Member Function Documentation

abort()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.abort

(

self

)

Stops movement of the stage.

Returns

int: error code (0:OK, -1:error)

ask()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.ask	(		self,
			param_dict = None
	)

Ask the magnet a question.

Parameters

dict	param_dict: dictionary, which passes all the relevant parameters, which should be changed. Usage: {'axis_label': <the question="" string>="">}. 'axis_label' must correspond to a label given to one of the axis.

Returns

dict: contains the answer to the specific axis coming from the magnet. Keywords are the axis names, item names are the string answers of the axis.

calibrate()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.calibrate	(		self,
			param_list = None
	)

Calibrates the stage.

Parameters

list	param_list: param_list: optional, if a specific calibration of an axis is desired, then the labels of the needed axis should be passed in the param_list. If nothing is passed, then all connected axis will be calibrated.

Returns

int: error code (0:OK, -1:error)

After calibration the stage moves to home position which will be the zero point for the passed axis. The calibration procedure will be different for each stage.

get_constraints()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.get_constraints

(

self

)

Retrieve the hardware constrains from the magnet driving device.

Returns

dict: dict with constraints for the magnet hardware. These constraints will be passed via the logic to the GUI so that proper display elements with boundary conditions could be made.

get_magnet_idle_state()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.get_magnet_idle_state

(

self

)

Retrieve the current state of the magnet, whether it is idle or not.

Returns

bool: the actual state which was set in the magnet hardware. True = idle, decoupled from control False = Not Idle, coupled to control

get_pos()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.get_pos	(		self,
			param_list = None
	)

Gets current position of the stage.

Parameters

list	param_list: optional, if a specific position of an axis is desired, then the labels of the needed axis should be passed in the param_list. If nothing is passed, then from each axis the position is asked.

Returns

dict: with keys being the axis labels and item the current position.

get_status()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.get_status	(		self,
			param_list = None
	)

Get the status of the position.

Parameters

list	param_list: optional, if a specific status of an axis is desired, then the labels of the needed axis should be passed in the param_list. If nothing is passed, then from each axis the status is asked.

Returns

dict: with the axis label as key and the status number as item.

get_velocity()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.get_velocity	(		self,
			param_list = None
	)

Gets the current velocity for all connected axes.

Parameters

list	param_list: optional, if a specific velocity of an axis is desired, then the labels of the needed axis should be passed as the param_list. If nothing is passed, then from each axis the velocity is asked.

Returns

dict: with the axis label as key and the velocity as item.

move_abs()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.move_abs	(		self,
			param_dict
	)

Moves stage to absolute position (absolute movement)

Parameters

dict	param_dict: dictionary, which passes all the relevant parameters, which should be changed. Usage: {'axis_label': <the-abs-pos-value>}. 'axis_label' must correspond to a label given to one of the axis.

Returns

dict pos: dictionary with changed axis and positions

move_rel()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.move_rel	(		self,
			param_dict
	)

Moves stage in given direction (relative movement)

Parameters

dict	param_dict: dictionary, which passes all the relevant parameters, which should be changed. Usage: {'axis_label': <the-abs-pos-value>}. 'axis_label' must correspond to a label given to one of the axis.

A smart idea would be to ask the position after the movement.

Returns

dict pos: dictionary with changed axis and positions

set_magnet_idle_state()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.set_magnet_idle_state	(		self,
			magnet_idle = True
	)

Set the magnet to couple/decouple to/from the control.

Parameters

bool	magnet_idle: if True then magnet will be set to idle and each movement command will be ignored from the hardware file. If False the magnet will react on movement changes of any kind.

Returns

bool: the actual state which was set in the magnet hardware. True = idle, decoupled from control False = Not Idle, coupled to control

set_velocity()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.set_velocity	(		self,
			param_dict = None
	)

Write new value for velocity.

Parameters

dict	param_dict: dictionary, which passes all the relevant parameters, which should be changed. Usage: {'axis_label': <the-velocity-value>}. 'axis_label' must correspond to a label given to one of the axis.

Returns

dict velocity: dictionary with axis and velocity

tell()

def magnet_motor_xyz_rot_interfuse.MagnetMotorXYZROTInterfuse.tell	(		self,
			param_dict = None
	)

Send a command to the magnet.

Parameters

dict	param_dict: dictionary, which passes all the relevant parameters, which should be changed. Usage: {'axis_label': <the command="" string>="">}. 'axis_label' must correspond to a label given to one of the axis.

Returns

int: error code (0:OK, -1:error)

---

The documentation for this class was generated from the following file:

• logic/interfuse/magnet_motor_xyz_rot_interfuse.py