VLCB::MinimumNodeServiceWithDiagnostics Class Reference

#include <MinimumNodeServiceWithDiagnostics.h>

Inheritance diagram for VLCB::MinimumNodeServiceWithDiagnostics:

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::MinimumNodeService
virtual void	process () override
	This method that be called regularly from the VLCB core to let the service perform regular tasks.
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.
virtual void	begin () override
	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.
void	setHeartBeat (bool f)
void	setSetupMode ()
	Forces instantMode to SETUP_MODE for testing purposes only.
void	setUninitialised ()
void	setNormal (unsigned int nn)
	Called when OPC_SNN is received. It will set MODE_NORMAL and the node number to nn.
Public Member Functions inherited from VLCB::Service
void	setController (Controller *ctrl)
	Set a pointer to the controller object for use in implementing class.
virtual Data	getServiceData ()
	Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification.

Protected Member Functions
virtual void	handleMessage (const VlcbMessage *msg) override
virtual void	diagNodeNumberChanged () override
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.

Additional Inherited Members
Protected Attributes inherited from VLCB::Service
Controller *	controller
	Pointer to the Controller object that can be used by implementing classes.

Member Function Documentation

reportDiagnostics()

void VLCB::MinimumNodeServiceWithDiagnostics::reportDiagnostics ( byte serviceIndex, byte diagnosticsCode )

overridevirtual

Report a given diagnostic value.

Parameters

serviceIndex	index of the service. Not used by the implementation, just passed through to the response message.
diagnosticsCode	code for the diagnostic to report. This code is specific to the implemented service.

Reimplemented from VLCB::Service.

getDiagnosticCount()

int VLCB::MinimumNodeServiceWithDiagnostics::getDiagnosticCount ( )

overridevirtual

report how many diagnostics this service supports.

Reimplemented from VLCB::Service.

handleMessage()

void VLCB::MinimumNodeServiceWithDiagnostics::handleMessage ( const VlcbMessage * msg )

overrideprotectedvirtual

Called when ACT_MESSAGE_IN is seen in the Action queue. If the VLCB message is of relevance to the MNS, it will act upon it before removing it from the Action queue either directly or in a called function.

Reimplemented from VLCB::MinimumNodeService.

diagNodeNumberChanged()

void VLCB::MinimumNodeServiceWithDiagnostics::diagNodeNumberChanged ( )

overrideprotectedvirtual

Called whenever the node number is changed. Count is recorded and held in Minimum Node Service With Diagnostics.

Reimplemented from VLCB::MinimumNodeService.

---

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

• MinimumNodeServiceWithDiagnostics.h
• MinimumNodeServiceWithDiagnostics.cpp