com.pi4j.component.relay

Class RelayBase

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.relay.RelayBase

All Implemented Interfaces:

Component, ObserveableComponent, Relay

Direct Known Subclasses:

GpioRelayComponent

public abstract class RelayBase
extends ObserveableComponentBase
implements Relay

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PULSE_MILLISECONDS

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

Constructor and Description
RelayBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RelayListener... listener)
void	close()
abstract RelayState	getState()
boolean	isClosed()
boolean	isOpen()
boolean	isState(RelayState state)
protected void	notifyListeners(RelayStateChangeEvent event)
void	open()
void	pulse()
void	pulse(int milliseconds)
void	removeListener(RelayListener... listener)
abstract void	setState(RelayState state)
void	toggle()

Methods inherited from class com.pi4j.component.ObserveableComponentBase

addListener, removeAllListeners, removeListener

Methods inherited from class com.pi4j.component.ComponentBase

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.component.ObserveableComponent

removeAllListeners

Methods inherited from interface com.pi4j.component.Component

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Field Detail

DEFAULT_PULSE_MILLISECONDS

public static final int DEFAULT_PULSE_MILLISECONDS

See Also:

Constant Field Values

Constructor Detail

RelayBase

public RelayBase()

Method Detail

open

public void open()

Specified by:

open in interface Relay

close

public void close()

Specified by:

close in interface Relay

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Relay

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Relay

getState

public abstract RelayState getState()

Specified by:

getState in interface Relay

setState

public abstract void setState(RelayState state)

Specified by:

setState in interface Relay

pulse

public void pulse()

Specified by:

pulse in interface Relay

pulse

public void pulse(int milliseconds)

Specified by:

pulse in interface Relay

toggle

public void toggle()

Specified by:

toggle in interface Relay

isState

public boolean isState(RelayState state)

Specified by:

isState in interface Relay

addListener

public void addListener(RelayListener... listener)

Specified by:

addListener in interface Relay

removeListener

public void removeListener(RelayListener... listener)

Specified by:

removeListener in interface Relay

notifyListeners

protected void notifyListeners(RelayStateChangeEvent event)