Classes |
Public Member Functions |
Static Public Attributes |
Protected Member Functions |
List of all members
IO::DMX512::Device Class Reference
#include <Device.h>
Inheritance diagram for IO::DMX512::Device:
Collaboration diagram for IO::DMX512::Device:
Classes | |
struct | Config |
DMX512 Device Configuration. More... | |
class | Factory |
Public Member Functions | |
const DeviceType | type () const override |
ErrorCode | init (const Config &config) |
ErrorCode | init (JsonObjectConst config) override |
IO::Request * | createRequest () override |
Create a request object for this device. More... | |
uint16_t | maxNodes () const override |
Determine maximum number of nodes supported by the device. More... | |
const NodeData & | getNodeData (uint8_t nodeId) const |
bool | isValid (DevNode node) const |
void | handleEvent (IO::Request *request, Event event) override |
Implementations may override this method to customise event handling. More... | |
![]() | |
Device (Controller &controller, const char *id) | |
ErrorCode | init (const Config &config) |
ErrorCode | init (JsonObjectConst config) override |
const DeviceType | type () const override |
Controller & | getController () |
uint16_t | address () const override |
Devices with a numeric address should implement this method. More... | |
uint8_t | segment () const |
unsigned | baudrate () const |
unsigned | timeout () const |
void | handleEvent (IO::Request *request, Event event) override |
Implementations may override this method to customise event handling. More... | |
![]() | |
Device (Controller &controller, const char *id) | |
Device constructor. More... | |
virtual | ~Device () |
ErrorCode | init (const Config &config) |
const CString & | getId () const |
The unique device identifier. More... | |
bool | operator== (const String &id) const |
const CString & | getName () const |
Optional descriptive name for the device. More... | |
unsigned | minTransactionInterval () const |
String | caption () const |
Obtain a descriptive caption for this device. More... | |
Controller & | getController () const |
Obtain the owning controller. More... | |
State | getState () |
Get current device state. More... | |
virtual DevNode::ID | nodeIdMin () const |
Get minimum valid Node ID for this device. More... | |
DevNode::ID | nodeIdMax () const |
Get maximum valid Node ID for this device. More... | |
virtual DevNode::States | getNodeStates (DevNode node) const |
Return the current set of states for all nodes controlled by this device. More... | |
![]() | |
Device * | getNext () const |
bool | insertAfter (Device *object) |
Iterator | begin () const |
Iterator | end () const |
Iterator | cbegin () const |
Iterator | cend () const |
![]() | |
virtual | ~LinkedObject () |
virtual LinkedObject * | next () const |
bool | insertAfter (LinkedObject *object) |
bool | operator== (const LinkedObject &other) const |
bool | operator!= (const LinkedObject &other) const |
Static Public Attributes | |
static const Factory | factory |
static constexpr size_t | MaxPacketSize {520} |
Protected Member Functions | |
void | parseJson (JsonObjectConst json, Config &cfg) |
ErrorCode | start () override |
bool | update () |
controller calls this before performing an update, typically for effects processing. Return true if value changed. More... | |
void | updateSlaves () |
ErrorCode | execute (Request &request) |
![]() | |
void | parseJson (JsonObjectConst json, Config &cfg) |
![]() | |
void | parseJson (JsonObjectConst json, Config &cfg) |
virtual ErrorCode | stop () |
void | submit (Request *request) |
Additional Inherited Members | |
![]() | |
enum class | State { stopped , starting , fault , normal } |
using | OwnedList = OwnedLinkedObjectListTemplate< Device > |
![]() | |
using | Iterator = IteratorTemplate< Device, Device *, Device & > |
using | ConstIterator = IteratorTemplate< const Device, const Device *, const Device & > |
![]() | |
Controller & | controller |
Member Function Documentation
◆ createRequest()
|
overridevirtual |
Create a request object for this device.
- Return values
-
Request* Caller must destroy or submit the request
Implements IO::Device.
◆ execute()
◆ getNodeData()
|
inline |
◆ handleEvent()
|
overridevirtual |
Implementations may override this method to customise event handling.
Reimplemented from IO::Device.
◆ init() [1/2]
◆ init() [2/2]
|
overridevirtual |
Implements IO::Device.
◆ isValid()
|
inline |
◆ maxNodes()
|
inlineoverridevirtual |
Determine maximum number of nodes supported by the device.
- Return values
-
uint16_t 0 if device doesn't support nodes
Reimplemented from IO::Device.
◆ parseJson()
|
protected |
◆ start()
|
inlineoverrideprotectedvirtual |
Reimplemented from IO::Device.
◆ type()
|
inlineoverridevirtual |
Implements IO::Device.
◆ update()
|
protected |
controller calls this before performing an update, typically for effects processing. Return true if value changed.
◆ updateSlaves()
|
protected |
Member Data Documentation
◆ factory
|
static |
◆ MaxPacketSize
|
staticconstexpr |
The documentation for this class was generated from the following file: