Service for managing node variables. More...

Inheritance diagram for VLCB::NodeVariableService:

Public Member Functions
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	processAction (const Action &action) override
	Called when there is an action available.
virtual Data	getServiceData () override
	Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification.
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::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::Service
Controller *	controller
	Pointer to the Controller object that can be used by implementing classes.

Detailed Description

Service for managing node variables.

This service allows node variables to be updated through a configuration utility such as FCU or MMC.

There are no user functions in this service.

Member Function Documentation

virtual VlcbServiceTypes VLCB::NodeVariableService::getServiceID ( ) const

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.

virtual byte VLCB::NodeVariableService::getServiceVersionID ( ) const

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.

void VLCB::NodeVariableService::processAction ( const Action & action )

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.

Service::Data VLCB::NodeVariableService::getServiceData ( )

overridevirtual

Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification.

Reimplemented from VLCB::Service.

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