com.pi4j.io.gpio

Class GpioProviderBase

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

All Implemented Interfaces:

GpioProvider

Direct Known Subclasses:

SimulatedGpioProvider, WiringPiGpioProviderBase

public abstract class GpioProviderBase
extends Object
implements GpioProvider

Abstract base implementation of GpioProvider.

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected GpioProviderPinCache[]	cache
static int	DEFAULT_CACHE_SIZE
protected boolean	isshutdown
protected Map<Pin,List<PinListener>>	listeners

Constructor Summary

Constructors

Constructor and Description
GpioProviderBase()

Method Summary

Modifier and Type	Method and Description
void	addListener(Pin pin, PinListener listener)
protected void	dispatchPinAnalogValueChangeEvent(Pin pin, double value)
protected void	dispatchPinDigitalStateChangeEvent(Pin pin, PinState state)
void	export(Pin pin, PinMode mode)
void	export(Pin pin, PinMode mode, PinState defaultState)
PinMode	getMode(Pin pin)
abstract String	getName()
protected GpioProviderPinCache	getPinCache(Pin pin)
PinPullResistance	getPullResistance(Pin pin)
int	getPwm(Pin pin)
PinState	getState(Pin pin)
double	getValue(Pin pin)
boolean	hasPin(Pin pin)
boolean	isExported(Pin pin)
boolean	isShutdown() This method returns TRUE if the GPIO provider has been shutdown.
void	removeAllListeners()
void	removeListener(Pin pin, PinListener listener)
void	setMode(Pin pin, PinMode mode)
void	setPullResistance(Pin pin, PinPullResistance resistance)
void	setPwm(Pin pin, int value)
void	setPwmRange(Pin pin, int range)
void	setState(Pin pin, PinState state)
void	setValue(Pin pin, double value)
void	shutdown()
void	unexport(Pin pin)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

listeners

protected final Map<Pin,List<PinListener>> listeners

cache

protected GpioProviderPinCache[] cache

isshutdown

protected boolean isshutdown

Constructor Detail

GpioProviderBase

public GpioProviderBase()

Method Detail

getName

public abstract String getName()

Specified by:

getName in interface GpioProvider

hasPin

public boolean hasPin(Pin pin)

Specified by:

hasPin in interface GpioProvider

getPinCache

protected GpioProviderPinCache getPinCache(Pin pin)

export

public void export(Pin pin,
                   PinMode mode,
                   PinState defaultState)

Specified by:

export in interface GpioProvider

export

public void export(Pin pin,
                   PinMode mode)

Specified by:

export in interface GpioProvider

isExported

public boolean isExported(Pin pin)

Specified by:

isExported in interface GpioProvider

unexport

public void unexport(Pin pin)

Specified by:

unexport in interface GpioProvider

setMode

public void setMode(Pin pin,
                    PinMode mode)

Specified by:

setMode in interface GpioProvider

getMode

public PinMode getMode(Pin pin)

Specified by:

getMode in interface GpioProvider

setPullResistance

public void setPullResistance(Pin pin,
                              PinPullResistance resistance)

Specified by:

setPullResistance in interface GpioProvider

getPullResistance

public PinPullResistance getPullResistance(Pin pin)

Specified by:

getPullResistance in interface GpioProvider

setState

public void setState(Pin pin,
                     PinState state)

Specified by:

setState in interface GpioProvider

getState

public PinState getState(Pin pin)

Specified by:

getState in interface GpioProvider

setValue

public void setValue(Pin pin,
                     double value)

Specified by:

setValue in interface GpioProvider

getValue

public double getValue(Pin pin)

Specified by:

getValue in interface GpioProvider

setPwm

public void setPwm(Pin pin,
                   int value)

Specified by:

setPwm in interface GpioProvider

setPwmRange

public void setPwmRange(Pin pin,
                        int range)

Specified by:

setPwmRange in interface GpioProvider

getPwm

public int getPwm(Pin pin)

Specified by:

getPwm in interface GpioProvider

addListener

public void addListener(Pin pin,
                        PinListener listener)

Specified by:

addListener in interface GpioProvider

removeListener

public void removeListener(Pin pin,
                           PinListener listener)

Specified by:

removeListener in interface GpioProvider

removeAllListeners

public void removeAllListeners()

Specified by:

removeAllListeners in interface GpioProvider

dispatchPinDigitalStateChangeEvent

protected void dispatchPinDigitalStateChangeEvent(Pin pin,
                                                  PinState state)

dispatchPinAnalogValueChangeEvent

protected void dispatchPinAnalogValueChangeEvent(Pin pin,
                                                 double value)

shutdown

public void shutdown()

Specified by:

shutdown in interface GpioProvider

isShutdown

public boolean isShutdown()

This method returns TRUE if the GPIO provider has been shutdown.

Specified by:

isShutdown in interface GpioProvider

Returns:

shutdown state