VLCB
Loading...
Searching...
No Matches
VLCB::EventTeachingServiceWithDiagnostics Class Reference

#include <EventTeachingServiceWithDiagnostics.h>

Inheritance diagram for VLCB::EventTeachingServiceWithDiagnostics:
VLCB::EventTeachingService VLCB::AbstractEventTeachingService VLCB::Service

Public Member Functions

virtual void reportDiagnostics (byte serviceIndex, byte diagnosticsCode) override
 Report a given diagnostic value.
virtual int getDiagnosticCount () override
 report how many diagnostics this service supports.
Public Member Functions inherited from VLCB::EventTeachingService
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.

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
Controllercontroller
 Pointer to the Controller object that can be used by implementing classes.

Member Function Documentation

◆ reportDiagnostics()

void VLCB::EventTeachingServiceWithDiagnostics::reportDiagnostics ( byte serviceIndex,
byte diagnosticsCode )
overridevirtual

Report a given diagnostic value.

Parameters
serviceIndexindex of the service. Not used by the implementation, just passed through to the response message.
diagnosticsCodecode for the diagnostic to report. This code is specific to the implemented service.

Reimplemented from VLCB::Service.

◆ getDiagnosticCount()

int VLCB::EventTeachingServiceWithDiagnostics::getDiagnosticCount ( )
overridevirtual

report how many diagnostics this service supports.

Reimplemented from VLCB::Service.


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