MotionLib  1.0.0
SamBuCa motion library
Public Types | Public Member Functions | List of all members
smc::internal::MFEAxis Class Reference
Inheritance diagram for smc::internal::MFEAxis:
Inheritance graph
[legend]
Collaboration diagram for smc::internal::MFEAxis:
Collaboration graph
[legend]

Public Types

typedef std::shared_ptr< MFEAxisShared
 
- Public Types inherited from smc::internal::MGrblAxis
typedef std::shared_ptr< MGrblAxisShared
 
- Public Types inherited from smc::internal::GrblAxis
typedef std::shared_ptr< GrblAxisShared
 
- Public Types inherited from smc::Axis
enum  State { UNKNOWN , IDLE , RUNNING , ERROR }
 Axis State. More...
 
typedef std::shared_ptr< AxisShared
 
- Public Types inherited from smc::DeviceBase
typedef smc::DeviceType DeviceType
 
typedef std::shared_ptr< DeviceBaseShared
 

Public Member Functions

 MFEAxis (const std::string &uid, const std::shared_ptr< MFEPlatform > &mfe, const std::shared_ptr< GrblPlatform > &grbl)
 
std::future< void > setActualPosition (const units::Value &position) const override
 Set current axis position. More...
 
std::future< std::set< std::string > > listConfig () const override
 list device configuration options
 
- Public Member Functions inherited from smc::internal::MGrblAxis
 MGrblAxis (const std::string &uid, const std::shared_ptr< MGrblPlatform > &mgrbl, const std::shared_ptr< GrblPlatform > &grbl)
 
std::future< void > moveTo (const units::Value &position) const override
 Move this axis to given position. More...
 
std::future< void > moveBy (const units::Value &distance) const override
 Move this axis by given distance. More...
 
std::future< void > stop () const override
 Stop any ongoing motion, flush the motion-queue. More...
 
std::future< void > pause () const override
 Pause ongoing motion, prevent queued motions from running. More...
 
std::future< void > resume () const override
 Resume paused motion. More...
 
std::future< units::value_tgetPosition (units::unit_t unit) const override
 Get current position of this axis. More...
 
units::value_t lastPosition (units::unit_t unit) const override
 Get last known position of the axis. More...
 
std::future< void > setActualPosition (const units::Value &position) const override
 Set current axis position. More...
 
std::future< void > takeReference (const std::chrono::milliseconds &timeout=std::chrono::seconds{ 120}) const override
 Start a homing sequence. More...
 
std::future< StategetState () const override
 Get the current axis state. More...
 
std::future< std::set< std::string > > listConfig () const override
 list device configuration options
 
std::future< std::string > getConfig (const std::string &name) const override
 get device configuration value More...
 
std::future< void > setConfig (const std::string &name, const std::string &value) const override
 set device configuration value More...
 
bool canConvert (const units::Value &value, units::unit_t unit) const override
 Check if unit conversion is possible in a manner specific to this device. More...
 
bool convert (units::Value &value, units::unit_t unit) const override
 Convert value in a manner specific to this device. More...
 
- Public Member Functions inherited from smc::internal::GrblAxis
 GrblAxis (const std::string &uid, const std::shared_ptr< GrblPlatform > &grbl)
 
- Public Member Functions inherited from smc::Axis
 Axis (const std::string &address)
 Construct a new Axis Device at given location on given platform. More...
 
DeviceType type () const override
 Get device type. More...
 
- Public Member Functions inherited from smc::DeviceBase
DeviceId uid () const
 Get the address of device. More...
 
std::string toString () const
 debug and logging operation
 

Additional Inherited Members

- Public Attributes inherited from smc::DeviceBase
ccut::Signal< const DeviceBase::Shared & > updateSignal
 device update signal More...
 
- Protected Member Functions inherited from smc::internal::MGrblAxis
void updateInstance () const
 
- Protected Member Functions inherited from smc::DeviceBase
 DeviceBase (const std::string &uid)
 Construct a new ABaseDevice, linking pointer to platform object. More...
 
- Protected Attributes inherited from smc::internal::MGrblAxis
std::weak_ptr< MGrblPlatformm_mgrbl
 
- Protected Attributes inherited from smc::internal::GrblAxis
std::weak_ptr< GrblPlatformm_grbl
 
- Protected Attributes inherited from smc::DeviceBase
const std::string m_uid
 

Detailed Description

Definition at line 34 of file MFEAxis.hpp.

Member Function Documentation

◆ setActualPosition()

std::future< void > MFEAxis::setActualPosition ( const units::Value position) const
overridevirtual

Set current axis position.

Parameters
positionnew position for axis
Returns
future<void> Future completed when command executed

Reimplemented from smc::internal::GrblAxis.

Definition at line 41 of file MFEAxis.cpp.

Here is the call graph for this function:

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