Motion Master
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OpenLoopFieldControl Class Reference

#include <open_loop_field_control.h>

Inheritance diagram for OpenLoopFieldControl:
Inheritance graph
[legend]
Collaboration diagram for OpenLoopFieldControl:
Collaboration graph
[legend]

Public Member Functions

 OpenLoopFieldControl (Cia402Drive &cia402_drive, int32_t angle, uint32_t velocity, uint32_t acceleration, uint32_t torque, uint32_t torque_speed)
 
MotionMasterError init () override
 Initialize open loop field control. More...
 
MotionMasterError start () override
 Start the open loop field control. More...
 
bool is_done () override
 Once the open loop field control procedure was started, this function is used to check if the procedure is done. More...
 
MotionMasterError get_result () override
 After the procedure is done, return the result. More...
 
MotionMasterError deinit () override
 Deinitialize open loop field control. More...
 
- Public Member Functions inherited from DeviceProcedure
virtual ~DeviceProcedure ()=default
 
virtual MotionMasterError init ()=0
 Initialize the procedure. More...
 
virtual MotionMasterError start ()=0
 Start the procedure. More...
 
virtual bool is_done ()=0
 Once the procedure is started, this function is used to check if the procedure is done. More...
 
virtual MotionMasterError get_result ()=0
 After the procedure is done, return the result. More...
 
virtual MotionMasterError deinit ()=0
 Deinitialize the procedure. More...
 

Constructor & Destructor Documentation

◆ OpenLoopFieldControl()

OpenLoopFieldControl::OpenLoopFieldControl ( Cia402Drive cia402_drive,
int32_t  angle,
uint32_t  velocity,
uint32_t  acceleration,
uint32_t  torque,
uint32_t  torque_speed 
)
explicit

Member Function Documentation

◆ deinit()

MotionMasterError OpenLoopFieldControl::deinit ( )
overridevirtual

Deinitialize open loop field control.

Returns
error if any

Implements DeviceProcedure.

◆ get_result()

MotionMasterError OpenLoopFieldControl::get_result ( )
overridevirtual

After the procedure is done, return the result.

Returns
error (if any)

Implements DeviceProcedure.

◆ init()

MotionMasterError OpenLoopFieldControl::init ( )
overridevirtual

Initialize open loop field control.

Returns
error if any

Implements DeviceProcedure.

◆ is_done()

bool OpenLoopFieldControl::is_done ( )
overridevirtual

Once the open loop field control procedure was started, this function is used to check if the procedure is done.

Returns
true is done, false otherwise

Implements DeviceProcedure.

◆ start()

MotionMasterError OpenLoopFieldControl::start ( )
overridevirtual

Start the open loop field control.

Returns
error

Implements DeviceProcedure.


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