smc::Trigger Class Reference

Inheritance diagram for smc::Trigger:

Collaboration diagram for smc::Trigger:

Public Types
typedef std::shared_ptr< Trigger >	Shared
Public Types inherited from smc::DeviceBase
typedef smc::DeviceType	DeviceType
typedef std::shared_ptr< DeviceBase >	Shared

Public Member Functions
	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...
virtual std::future< void >	arm () const =0
	arm the trigger More...
virtual std::future< void >	disarm () const =0
	disarm the trigger More...
virtual std::future< bool >	isArmed () const =0
	check if trigger is armed More...
virtual std::future< void >	trig () const =0
	soft-trigger the trigger
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

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...
Protected Attributes inherited from smc::DeviceBase
const std::string	m_uid

Detailed Description

Definition at line 40 of file Trigger.hpp.

Constructor & Destructor Documentation

Trigger()

smc::Trigger::Trigger

(

const std::string &

address

)

Construct a new Trigger Device at given location on given platform.

Parameters

address	unique address of the device
platform	Platform on which this device is located
config	optional config platform

Definition at line 33 of file Trigger.cpp.

Member Function Documentation

arm()

virtual std::future<void> smc::Trigger::arm ( ) const

pure virtual

arm the trigger

Returns

future<void> Future completed once command executed

Implemented in smc::internal::MGrblTrigger, smc::internal::MGrblMainTrigger, and smc::internal::GrblTrigger.

disarm()

virtual std::future<void> smc::Trigger::disarm ( ) const

pure virtual

disarm the trigger

Returns

future<void> Future completed once command executed

Implemented in smc::internal::MGrblTrigger, smc::internal::MGrblMainTrigger, and smc::internal::GrblTrigger.

isArmed()

virtual std::future<bool> smc::Trigger::isArmed ( ) const

pure virtual

check if trigger is armed

Returns

future<void> Future completed once command executed

Implemented in smc::internal::MGrblTrigger, smc::internal::MGrblMainTrigger, and smc::internal::GrblTrigger.

type()

DeviceBase::DeviceType smc::Trigger::type ( ) const

overridevirtual

Get device type.

Returns

DeviceType TRIGGER device type

Implements smc::DeviceBase.

Definition at line 35 of file Trigger.cpp.

---

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

• /builds/mro/controls/sambuca/sambuca-motion-lib/src/device/Trigger.hpp
• /builds/mro/controls/sambuca/sambuca-motion-lib/src/device/Trigger.cpp