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

Public Types

typedef std::shared_ptr< GrblPlatformDeviceShared
 
- Public Types inherited from smc::PlatformDevice
typedef std::shared_ptr< PlatformDeviceShared
 
- Public Types inherited from smc::DeviceBase
typedef smc::DeviceType DeviceType
 
typedef std::shared_ptr< DeviceBaseShared
 

Public Member Functions

 GrblPlatformDevice (const std::string &uid, const std::shared_ptr< GrblPlatform > &grbl)
 
virtual std::future< std::set< std::string > > listConfig () const override
 list device configuration options
 
virtual std::future< std::string > getConfig (const std::string &name) const override
 get device configuration value More...
 
virtual std::future< void > setConfig (const std::string &name, const std::string &value) const override
 set device configuration value More...
 
- Public Member Functions inherited from smc::PlatformDevice
 PlatformDevice (const std::string &uid)
 
DeviceType type () const override
 
- Public Member Functions inherited from smc::DeviceBase
DeviceId uid () const
 Get the address of device. More...
 
virtual bool canConvert (const units::Value &value, units::unit_t unit) const
 Check if unit conversion is possible in a manner specific to this device. More...
 
virtual bool convert (units::Value &value, units::unit_t unit) const
 Convert value in a manner specific to this device. More...
 
std::string toString () const
 debug and logging operation
 

Protected Attributes

std::weak_ptr< GrblPlatformm_grbl
 
- Protected Attributes inherited from smc::DeviceBase
const std::string m_uid
 

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::DeviceBase
 DeviceBase (const std::string &uid)
 Construct a new ABaseDevice, linking pointer to platform object. More...
 

Detailed Description

Definition at line 34 of file GrblPlatformDevice.hpp.

Member Function Documentation

◆ getConfig()

std::future< std::string > GrblPlatformDevice::getConfig ( const std::string &  name) const
overridevirtual

get device configuration value

Parameters
namevalue to retrieve
Returns
the current value (yml encoded)

Reimplemented from smc::DeviceBase.

Reimplemented in smc::internal::MGrblPlatformDevice.

Definition at line 63 of file GrblPlatformDevice.cpp.

◆ setConfig()

std::future< void > GrblPlatformDevice::setConfig ( const std::string &  name,
const std::string &  value 
) const
overridevirtual

set device configuration value

Parameters
namename of the configuration value to set
valuevalue to set

Reimplemented from smc::DeviceBase.

Reimplemented in smc::internal::MGrblPlatformDevice.

Definition at line 90 of file GrblPlatformDevice.cpp.


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