base class for led light box controllers More...
#include <led_lightbox_controller.h>
Inheritance diagram for ControlAPI::LedLightBoxControllerBase:
Additional Inherited Members | |
 Public Member Functions inherited from ControlAPI::HardwareDeviceController | |
| virtual std::string | className () override |
| Public Member Functions inherited from ControlAPI::DeviceController | |
| virtual bool | checkCommandPackage (int deviceId, DeviceCommandPackage *package) |
| check validity of command package | |
| void | addDeviceInfo (DeviceInfo *dev) |
| Add a device to the controller. More... | |
| void | removeDeviceInfo (DeviceInfo *dev) |
| Remove an already added device. | |
| void | setDisconnectCallback (std::function< void(bool)> callback) |
| set a disconnected callback function to be called when the controller is disconnected. | |
| virtual void | disconnect (bool expected=false) |
| disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed. | |
| bool | isConnected () |
| returns true if the controller is currently connected. | |
| int | apiId () |
| the assigned Api Id of the controller | |
| void | setSimulated (bool simulated) |
| set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. More... | |
| bool | isSimulated () |
| return if the controller is simulated. More... | |
| Public Member Functions inherited from ControlAPI::LoggerFunctionality | |
| std::shared_ptr< spdlog::logger > | getLogger () |
| std::string | loggerName () |
| Static Public Member Functions inherited from ControlAPI::HardwareDeviceController | |
| static std::string | staticClassName () |
| Static Public Member Functions inherited from ControlAPI::DeviceController | |
| static std::string | staticClassName () |
| Static Public Member Functions inherited from ControlAPI::LoggerFunctionality | |
| static std::string | staticClassName () |
| Public Attributes inherited from ControlAPI::DeviceController | |
| std::string | alias |
| Alias of the controller. | |
| std::string | port |
| port for connecting, if the device is a serial device this can be "COM3" or "/dev/tty.***" | |
| Protected Attributes inherited from ControlAPI::LoggerFunctionality | |
| std::shared_ptr< spdlog::logger > | logger |
| ControlSystem * | controlSystem = nullptr |
Detailed Description
base class for led light box controllers
The documentation for this class was generated from the following file:
- led_lightbox_controller/led_lightbox_controller.h