Package io.openems.edge.common.channel

Class BooleanDoc

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

All Implemented Interfaces:

Doc

Direct Known Subclasses:

StateChannelDoc

public class BooleanDoc
extends OpenemsTypeDoc<Boolean>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	debounce	Debounce the State-Channel value: the StateChannel is only set to true after it had been set to true for at least "debounce" times.
protected Debounce	debounceMode

Constructor Summary

Constructors

Constructor	Description
BooleanDoc()

Method Summary

Modifier and Type	Method	Description
BooleanReadChannel	createChannelInstance(OpenemsComponent component, ChannelId channelId)	Creates an instance of Channel for the given Channel-ID using its Channel-AbstractDoc.
BooleanDoc	debounce(int debounce, Debounce debounceMode)	Add a debounce before actually setting the channel value.
int	getDebounce()
Debounce	getDebounceMode()
protected BooleanDoc	self()	Gets an instance of the correct subclass of myself.

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

accessMode, getChannelCategory, 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

Field Details

debounce

protected int debounce

Debounce the State-Channel value: the StateChannel is only set to true after it had been set to true for at least "debounce" times.

debounceMode

protected Debounce debounceMode

Constructor Details

BooleanDoc

public BooleanDoc()

Method Details

self

protected BooleanDoc self()

Description copied from class: AbstractDoc

Gets an instance of the correct subclass of myself.

Specified by:

self in class AbstractDoc<Boolean>

Returns:

myself

createChannelInstance

public BooleanReadChannel createChannelInstance(OpenemsComponent component,
 ChannelId channelId)

Description copied from class: AbstractDoc

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

Specified by:

createChannelInstance in interface Doc

Specified by:

createChannelInstance in class AbstractDoc<Boolean>

Parameters:

component - the OpenemsComponent

channelId - the ChannelId

Returns:

the Channel

debounce

public BooleanDoc debounce(int debounce,
 Debounce debounceMode)

Add a debounce before actually setting the channel value.

Parameters:

debounce - the debounce counter

debounceMode - the Debounce mode

Returns:

myself

getDebounce

public int getDebounce()

getDebounceMode

public Debounce getDebounceMode()