Package io.openems.edge.io.gpio.api

Class AbstractGpioChannel

java.lang.Object

io.openems.edge.io.gpio.api.AbstractGpioChannel

All Implemented Interfaces:

ChannelId

Direct Known Subclasses:

ReadChannelId, WriteChannelId

public abstract class AbstractGpioChannel
extends Object
implements ChannelId

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.common.channel.ChannelId

ChannelId.ChannelIdImpl

Field Summary

Fields

Modifier and Type	Field	Description
final int	gpio	The GPIO number of the hardware entity.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGpioChannel(int gpio, String name, Doc doc)

Method Summary

Modifier and Type	Method	Description
final Doc	doc()	Gets the Channel Doc for this ChannelId.
final String	name()	Gets the name in format CaseFormat.UPPER_UNDERSCORE.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.common.channel.ChannelId

id

Field Details

gpio

public final int gpio

The GPIO number of the hardware entity.

Constructor Details

AbstractGpioChannel

protected AbstractGpioChannel(int gpio,
 String name,
 Doc doc)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

name

public final String name()

Description copied from interface: ChannelId

Gets the name in format CaseFormat.UPPER_UNDERSCORE. This is available by default for an Enum.

Names starting with underscore ("_") are reserved for internal usage.

Specified by:

name in interface ChannelId

Returns:

the name

doc

public final Doc doc()

Description copied from interface: ChannelId

Gets the Channel Doc for this ChannelId.

Specified by:

doc in interface ChannelId

Returns:

the Channel-Doc