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

Public Types

typedef std::shared_ptr< GrblTriggerShared
 
- Public Types inherited from smc::Trigger
typedef std::shared_ptr< TriggerShared
 
- Public Types inherited from smc::DeviceBase
typedef smc::DeviceType DeviceType
 
typedef std::shared_ptr< DeviceBaseShared
 

Public Member Functions

 GrblTrigger (const std::string &uid, const std::shared_ptr< GrblPlatform > &grbl)
 
std::future< void > arm () const override
 arm the trigger More...
 
std::future< void > disarm () const override
 disarm the trigger More...
 
std::future< bool > isArmed () const override
 check if trigger is armed More...
 
std::future< void > trig () const override
 soft-trigger the trigger
 
- Public Member Functions inherited from smc::Trigger
 Trigger (const std::string &address)
 Construct a new Trigger 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...
 
virtual std::future< std::set< std::string > > listConfig () const
 list device configuration options
 
virtual std::future< std::string > getConfig (const std::string &name) const
 get device configuration value More...
 
virtual std::future< void > setConfig (const std::string &name, const std::string &value) const
 set device configuration value 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 36 of file GrblTrigger.hpp.

Member Function Documentation

◆ arm()

std::future< void > GrblTrigger::arm ( ) const
overridevirtual

arm the trigger

Returns
future<void> Future completed once command executed

Implements smc::Trigger.

Reimplemented in smc::internal::MGrblTrigger.

Definition at line 45 of file GrblTrigger.cpp.

◆ disarm()

std::future< void > GrblTrigger::disarm ( ) const
overridevirtual

disarm the trigger

Returns
future<void> Future completed once command executed

Implements smc::Trigger.

Reimplemented in smc::internal::MGrblTrigger.

Definition at line 68 of file GrblTrigger.cpp.

Here is the caller graph for this function:

◆ isArmed()

std::future< bool > GrblTrigger::isArmed ( ) const
overridevirtual

check if trigger is armed

Returns
future<void> Future completed once command executed

Implements smc::Trigger.

Reimplemented in smc::internal::MGrblTrigger.

Definition at line 91 of file GrblTrigger.cpp.


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