MotionLib  1.0.0
SamBuCa motion library
Public Types | Public Member Functions | List of all members
smc::PlatformDevice Class Reference

#include <PlatformDevice.hpp>

Inheritance diagram for smc::PlatformDevice:
Inheritance graph
[legend]
Collaboration diagram for smc::PlatformDevice:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 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 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

this device is mainly used to configure platform

Definition at line 43 of file PlatformDevice.hpp.

Constructor & Destructor Documentation

◆ PlatformDevice()

smc::PlatformDevice::PlatformDevice ( const std::string &  uid)
explicit

this object should by created by a Platform

Parameters
uidplatform device uid
configassociated config platform

Definition at line 29 of file PlatformDevice.cpp.


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