c_InputDisabled Class Reference

#include <InputDisabled.hpp>

Inheritance diagram for c_InputDisabled:

Collaboration diagram for c_InputDisabled:

Public Member Functions
	c_InputDisabled (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
virtual	~c_InputDisabled ()
void	Begin ()
	set up the operating environment based on the current config (or defaults)
bool	SetConfig (JsonObject &jsonConfig)
	Set a new config in the driver.
void	GetConfig (JsonObject &jsonConfig)
	Get the current config used by the driver.
void	GetStatus (JsonObject &jsonStatus)
void	Process ()
	Call from loop(), renders Input data.
void	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
void	SetBufferInfo (uint32_t BufferSize)
Public Member Functions inherited from c_InputCommon
	c_InputCommon (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
	< Start up the driver and put it into a safe mode
virtual	~c_InputCommon ()
virtual bool	SetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Set a new config in the driver.
virtual void	GetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Get the current config used by the driver.
virtual void	SetOperationalState (bool ActiveFlag)
virtual void	NetworkStateChanged (bool IsConnected)
virtual bool	isShutDownRebootNeeded ()
virtual void	ProcessButtonActions (c_ExternalInput::InputValue_t value)
virtual void	ClearStatistics (void)
virtual void	SetBlankTimerIsRunning (bool value)
c_InputMgr::e_InputChannelIds	GetInputChannelId ()
c_InputMgr::e_InputType	GetInputType ()

Additional Inherited Members
Protected Attributes inherited from c_InputCommon
bool	HasBeenInitialized = false
uint32_t	InputDataBufferSize = 0
bool	IsInputChannelActive = true
bool	IsBlankTimerRunning = false
c_InputMgr::e_InputChannelIds	InputChannelId = c_InputMgr::e_InputChannelIds::InputChannelId_ALL
c_InputMgr::e_InputType	ChannelType = c_InputMgr::e_InputType::InputType_Disabled

Constructor & Destructor Documentation

c_InputDisabled()

c_InputDisabled::c_InputDisabled	(	c_InputMgr::e_InputChannelIds	NewInputChannelId,
		c_InputMgr::e_InputType	NewChannelType,
		uint32_t	BufferSize )

~c_InputDisabled()

c_InputDisabled::~c_InputDisabled ( )

virtual

Member Function Documentation

Begin()

void c_InputDisabled::Begin ( )

virtual

set up the operating environment based on the current config (or defaults)

Implements c_InputCommon.

GetConfig()

void c_InputDisabled::GetConfig

(

JsonObject &

jsonConfig

)

Get the current config used by the driver.

GetDriverName()

void c_InputDisabled::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

GetStatus()

void c_InputDisabled::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

Process()

void c_InputDisabled::Process ( )

virtual

Call from loop(), renders Input data.

Implements c_InputCommon.

SetBufferInfo()

void c_InputDisabled::SetBufferInfo ( uint32_t BufferSize )

inlinevirtual

Implements c_InputCommon.

SetConfig()

bool c_InputDisabled::SetConfig

(

JsonObject &

jsonConfig

)

Set a new config in the driver.

---

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

• /github/workspace/include/input/InputDisabled.hpp
• /github/workspace/src/input/InputDisabled.cpp