Slot Event Teaching Service. More...
#include <EventSlotTeachingService.h>
Public Member Functions | |
| virtual void | processAction (const Action &action) override |
| Called when there is an action available. | |
| virtual VlcbServiceTypes | getServiceID () const override |
| Return a unique ID for this service. | |
| virtual byte | getServiceVersionID () const override |
| Return the version of the service specification implemented by this service. | |
| Public Member Functions inherited from VLCB::AbstractEventTeachingService | |
| void | setEventValidator (byte(*func)(int nn, int en, byte evNum, byte evVal)) |
| virtual Data | getServiceData () override |
| Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification. | |
| void | enableLearn () |
| void | inhibitLearn () |
| Public Member Functions inherited from VLCB::Service | |
| void | setController (Controller *ctrl) |
| Set a pointer to the controller object for use in implementing class. | |
| virtual void | begin () |
| This optional method is called at the beginning of the Arduino sketch. Define this method for the service to do any setup required at the beginning. | |
| virtual void | process () |
| This method that be called regularly from the VLCB core to let the service perform regular tasks. | |
| virtual void | reportDiagnostics (byte serviceIndex, byte diagnosticsCode) |
| Report a given diagnostic value. | |
| virtual int | getDiagnosticCount () |
| report how many diagnostics this service supports. | |
Additional Inherited Members | |
| Protected Member Functions inherited from VLCB::AbstractEventTeachingService | |
| void | handleMessage (const VlcbMessage *msg) |
| Protected Member Functions inherited from VLCB::Service | |
| bool | isThisNodeNumber (unsigned int nodeNumber) |
| Helper function to decide if a given node number is the same as that assigned to this node. | |
| Protected Attributes inherited from VLCB::AbstractEventTeachingService | |
| bool | bLearn = false |
| byte(* | validatorFunc )(int nn, int en, byte evNum, byte evVal) = nullptr |
| unsigned int | diagEventsTaught = 0 |
| Protected Attributes inherited from VLCB::Service | |
| Controller * | controller |
| Pointer to the Controller object that can be used by implementing classes. | |
Detailed Description
Slot Event Teaching Service.
This service allows an Events Table to be created and managed using the MMC or similar. A full description of events can be found in the document VLCB Event Model. The Events Table is used by the Producer and Consumer Services. This Event Teaching Service is only required if one or both of these other services are present. With this service events are organised in the events table so that each slot (table entry) has a meaning defined by the user sketch.
There are no user functions in this service.
Member Function Documentation
◆ processAction()
|
overridevirtual |
Called when there is an action available.
This method does not need to be implemented if the service does react to any actions.
- Parameters
-
action The action that the service may have interest in.
Reimplemented from VLCB::Service.
◆ getServiceID()
|
inlineoverridevirtual |
Return a unique ID for this service.
This ID is used by configuration utilities to identify the service type. The service IDs are listed in the VLCB service specifications.
Implements VLCB::Service.
◆ getServiceVersionID()
|
inlineoverridevirtual |
Return the version of the service specification implemented by this service.
This version is used by configuration utilities to identify which features are implemented by this service.
Implements VLCB::Service.
The documentation for this class was generated from the following files:
