io.openems.edge.common.channel

Class BooleanWriteChannel

java.lang.Object

io.openems.edge.common.channel.internal.AbstractReadChannel<OpenemsTypeDoc<java.lang.Boolean>,java.lang.Boolean>

io.openems.edge.common.channel.BooleanReadChannel

io.openems.edge.common.channel.BooleanWriteChannel

All Implemented Interfaces:

Channel<java.lang.Boolean>, WriteChannel<java.lang.Boolean>

public class BooleanWriteChannel
extends BooleanReadChannel
implements WriteChannel<java.lang.Boolean>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BooleanWriteChannel.MirrorToDebugChannel

Field Summary

Fields inherited from class io.openems.edge.common.channel.internal.AbstractReadChannel

NO_OF_PAST_VALUES, parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BooleanWriteChannel(OpenemsComponent component, ChannelId channelId, BooleanDoc channelDoc)

Method Summary

Modifier and Type	Method and Description
void	_setNextWriteValue(java.lang.Boolean value) Deprecated.
java.util.Optional<java.lang.Boolean>	getNextWriteValue() Gets the next write value.
java.util.List<ThrowingConsumer<java.lang.Boolean,OpenemsError.OpenemsNamedException>>	getOnSetNextWrites()
void	onSetNextWrite(ThrowingConsumer<java.lang.Boolean,OpenemsError.OpenemsNamedException> callback) Add an onSetNextWrite callback.

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

_setNextValue, address, channelDoc, channelId, deactivate, getComponent, getNextValue, getPastValues, getType, nextProcessImage, onChange, onSetNextValue, onUpdate, removeOnChangeCallback, removeOnSetNextValueCallback, removeOnUpdateCallback, toString, value

Methods inherited from class java.lang.Object

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

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

getNextWriteValueAndReset, setNextWriteValue, setNextWriteValueFromObject

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

_setNextValue, address, channelDoc, channelId, deactivate, getComponent, getNextValue, getPastValues, getType, nextProcessImage, onChange, onSetNextValue, onUpdate, removeOnChangeCallback, removeOnSetNextValueCallback, removeOnUpdateCallback, setNextValue, value

Constructor Detail

BooleanWriteChannel

protected BooleanWriteChannel(OpenemsComponent component,
                              ChannelId channelId,
                              BooleanDoc channelDoc)

Method Detail

_setNextWriteValue

@Deprecated
public void _setNextWriteValue(java.lang.Boolean value)

Deprecated.

Internal method. Do not call directly.

Specified by:

_setNextWriteValue in interface WriteChannel<java.lang.Boolean>

Parameters:

value -

getNextWriteValue

public java.util.Optional<java.lang.Boolean> getNextWriteValue()

Description copied from interface: WriteChannel

Gets the next write value.

Specified by:

getNextWriteValue in interface WriteChannel<java.lang.Boolean>

Returns:

the next write value; not-present if no write value had been set

getOnSetNextWrites

public java.util.List<ThrowingConsumer<java.lang.Boolean,OpenemsError.OpenemsNamedException>> getOnSetNextWrites()

Specified by:

getOnSetNextWrites in interface WriteChannel<java.lang.Boolean>

Overrides:

getOnSetNextWrites in class AbstractReadChannel<OpenemsTypeDoc<java.lang.Boolean>,java.lang.Boolean>

onSetNextWrite

public void onSetNextWrite(ThrowingConsumer<java.lang.Boolean,OpenemsError.OpenemsNamedException> callback)

Description copied from interface: WriteChannel

Add an onSetNextWrite callback. It is called when a 'next write value' was set.

The callback can throw an OpenemsError.OpenemsNamedException.

Specified by:

onSetNextWrite in interface WriteChannel<java.lang.Boolean>