smc::PositionSensor Class Reference

Inheritance diagram for smc::PositionSensor:

Collaboration diagram for smc::PositionSensor:

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

Public Member Functions
	PositionSensor (const std::string &address)
	Construct a new POSITION Device at given location on given platform. More...
DeviceType	type () const override
	Get device type. More...
virtual std::future< units::value_t >	getPosition (units::unit_t unit) const =0
	Get current position value. More...
virtual std::future< void >	setActualPosition (const units::value_t &value) const
	Set the current position value. More...
virtual units::value_t	lastPosition (units::unit_t unit) const =0
	Get last known position. 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

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 41 of file PositionSensor.hpp.

Constructor & Destructor Documentation

PositionSensor()

smc::PositionSensor::PositionSensor

(

const std::string &

address

)

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

Parameters

platform	Platform on which POSITION is located
address	Unique address of the POSITION

Definition at line 31 of file PositionSensor.cpp.

Member Function Documentation

getPosition()

virtual std::future<units::value_t> smc::PositionSensor::getPosition ( units::unit_t  unit ) const

pure virtual

Get current position value.

Parameters

unit	unit to get position in

Returns

future<mm> Future completed with value when command executed.

Implemented in smc::internal::MockPositionSensor, and smc::internal::MFEPositionSensor.

lastPosition()

virtual units::value_t smc::PositionSensor::lastPosition ( units::unit_t  unit ) const

pure virtual

Get last known position.

Parameters

unit	unit to get position in

Returns

units::value_t

Implemented in smc::internal::MockPositionSensor, and smc::internal::MFEPositionSensor.

setActualPosition()

std::future< void > smc::PositionSensor::setActualPosition ( const units::value_t &  value ) const

virtual

Set the current position value.

Parameters

value

value to set

Reimplemented in smc::internal::MockPositionSensor, and smc::internal::MFEPositionSensor.

Definition at line 39 of file PositionSensor.cpp.

type()

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

overridevirtual

Get device type.

Returns

DeviceType POSITION device type

Implements smc::DeviceBase.

Definition at line 34 of file PositionSensor.cpp.

---

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

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