Package io.openems.edge.common.channel

Class StateChannelDoc

java.lang.Object

io.openems.edge.common.channel.internal.AbstractDoc<T>

io.openems.edge.common.channel.internal.OpenemsTypeDoc<Boolean>

io.openems.edge.common.channel.BooleanDoc

io.openems.edge.common.channel.StateChannelDoc

All Implemented Interfaces:

Doc

Direct Known Subclasses:

ErrorDoc

public class StateChannelDoc
extends BooleanDoc

Field Summary

Fields inherited from class io.openems.edge.common.channel.BooleanDoc

debounce, debounceMode

Constructor Summary

Constructors

Constructor	Description
StateChannelDoc(Level level)

Method Summary

Modifier and Type	Method	Description
StateChannel	createChannelInstance(OpenemsComponent component, ChannelId channelId)	Creates an instance of Channel for the given Channel-ID using its Channel-Doc.
ChannelCategory	getChannelCategory()	Gets the ChannelCategory of the Channel of this Doc.
Level	getLevel()
protected StateChannelDoc	self()	Gets an instance of the correct subclass of myself.

Methods inherited from class io.openems.edge.common.channel.BooleanDoc

debounce, getDebounce, getDebounceMode

Methods inherited from class io.openems.edge.common.channel.internal.OpenemsTypeDoc

accessMode, getUnit, of, unit

Methods inherited from class io.openems.edge.common.channel.internal.AbstractDoc

debug, getAccessMode, getInitialValue, getOnInitCallbacks, getPersistencePriority, getText, getType, initialValue, isDebug, onInit, persistencePriority, text

Methods inherited from class java.lang.Object

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

Constructor Details

StateChannelDoc

public StateChannelDoc(Level level)

Method Details

getChannelCategory

public ChannelCategory getChannelCategory()

Description copied from interface: Doc

Gets the ChannelCategory of the Channel of this Doc.

Specified by:

getChannelCategory in interface Doc

Overrides:

getChannelCategory in class OpenemsTypeDoc<Boolean>

Returns:

the ChannelCategory

self

protected StateChannelDoc self()

Description copied from class: AbstractDoc

Gets an instance of the correct subclass of myself.

Overrides:

self in class BooleanDoc

Returns:

myself

getLevel

public Level getLevel()

createChannelInstance

public StateChannel createChannelInstance(OpenemsComponent component,
 ChannelId channelId)

Creates an instance of Channel for the given Channel-ID using its Channel-Doc.

Specified by:

createChannelInstance in interface Doc

Overrides:

createChannelInstance in class BooleanDoc

Parameters:

channelId - the Channel-ID

component - the OpenemsComponent

Returns:

the Channel