Class Index | File Index

Classes


Class BO.PhysicalInputBase

A base class for physical input objects. Extend this class to create new digital or analog input objects. Treat this class as an abstract base class. It should not be instantiated directly.

Defined in: PhysicalInputBase.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A base class for physical inputs.
Method Summary
Method Attributes Method Name and Description
 
addEventListener(type, listener)
 
dispatchEvent(type, optionalParams)
 
 
removeEventListener(type, listener)
Class Detail
BO.PhysicalInputBase()
A base class for physical inputs. Treat this class as an abstract base class - do not instantiate it directly.
Method Detail
addEventListener(type, listener)
Parameters:
{String} type
The event type
{Function} listener
The function to be called when the event is fired

dispatchEvent(type, optionalParams)
Parameters:
{Event} type
The Event object
{Object} optionalParams
Optional parameters to assign to the event object. return {boolean} True if dispatch is successful, false if not.

hasEventListener(type)
Parameters:
{String} type
The event type return {boolean} True is listener exists for this type, false if not.

removeEventListener(type, listener)
Parameters:
{String} type
The event type
{Function} listener
The function to be called when the event is fired

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 12 2012 23:27:53 GMT-0400 (EDT)