DeviceProcedure Class Reference

#include <device_procedure.h>

Inheritance diagram for DeviceProcedure:

Public Member Functions
virtual	~DeviceProcedure ()=default
virtual MotionMasterError	init ()=0
	Initialize the procedure.
virtual MotionMasterError	start ()=0
	Start the procedure.
virtual bool	is_done ()=0
	Once the procedure is started, this function is used to check if the procedure is done.
virtual MotionMasterError	get_result ()=0
	After the procedure is done, return the result.
virtual MotionMasterError	deinit ()=0
	Deinitialize the procedure.

Constructor & Destructor Documentation

~DeviceProcedure()

virtual DeviceProcedure::~DeviceProcedure ( )

virtualdefault

Member Function Documentation

deinit()

virtual MotionMasterError DeviceProcedure::deinit ( )

pure virtual

Deinitialize the procedure.

Returns

error if any

Implemented in OpenLoopFieldControl.

get_result()

virtual MotionMasterError DeviceProcedure::get_result ( )

pure virtual

After the procedure is done, return the result.

Returns

error (if any)

Implemented in OpenLoopFieldControl.

init()

virtual MotionMasterError DeviceProcedure::init ( )

pure virtual

Initialize the procedure.

Returns

error if any

Implemented in OpenLoopFieldControl.

is_done()

virtual bool DeviceProcedure::is_done ( )

pure virtual

Once the procedure is started, this function is used to check if the procedure is done.

Returns

true is done, false otherwise

Implemented in OpenLoopFieldControl.

start()

virtual MotionMasterError DeviceProcedure::start ( )

pure virtual

Start the procedure.

Returns

error

Implemented in OpenLoopFieldControl.

---

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

• apps/motion_master/device_procedure.h