Package elisa :: Package core :: Package components :: Module input_provider :: Class InputProvider

Class InputProvider

Input events provider class. Plugins can't subclass it directly, they have to use either PollInputProvider or PushInputProvider classes.

Instance Methods

create_input_event(self, data)
Translate external input data to an InputEvent object, understandable by the InputManager.

source code

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from component.Component

twisted.internet.defer.Deferred

clean(self)
Clean the component.

source code

twisted.internet.defer.Deferred

initialize(self, **kwargs)
Initialize the component.

source code

name__get(self)

source code

name__set(self, value)

source code

Inherited from log.Loggable

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

Class Methods

Inherited from component.Component

elisa.core.component.Component or a subclass

create(cls, config_section=None, **kwargs)
Create and initialize the component.

source code

Inherited from component.Component
Class Variables
Inherited from `extern.log.log.Loggable`: `logCategory`
	config_doc = `{}`
	default_config = `{}`
	name = `property(fget= name__get, fset= name__set)`
	path = `PathDescriptor()`

Properties
Inherited from `object`: `__class__`

Method Details

create_input_event(self, data)

source code

Translate external input data to an InputEvent object, understandable by the InputManager. This method has to be overriden by InputProvider implementations. This method is called by InputProvider implementations.

Parameters:

data - the data to translate, can be of any type

Returns:

elisa.core.input_event.InputEvent