Package io.openems.edge.common.channel

Class BooleanWriteChannel

java.lang.Object

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

io.openems.edge.common.channel.BooleanReadChannel

io.openems.edge.common.channel.BooleanWriteChannel

All Implemented Interfaces:

Channel<Boolean>, WriteChannel<Boolean>

public class BooleanWriteChannel
extends BooleanReadChannel
implements WriteChannel<Boolean>

Field Summary

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

parent

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

MAX_AGE_OF_PAST_VALUES

Constructor Summary

Constructors

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

Method Summary

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

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

_setNextValue

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

address, channelDoc, channelId, deactivate, getComponent, getMetaInfo, getNextValue, getPastValues, getType, nextProcessImage, onChange, onSetNextValue, onUpdate, removeOnChangeCallback, removeOnSetNextValueCallback, removeOnUpdateCallback, setMetaInfo, 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.Channel

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

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

getNextWriteValueAndReset, setNextWriteValue, setNextWriteValueFromObject

Constructor Details

BooleanWriteChannel

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

Method Details

_setNextWriteValue

@Deprecated
public void _setNextWriteValue(Boolean value)

Deprecated.

Internal method. Do not call directly.

Specified by:

_setNextWriteValue in interface WriteChannel<Boolean>

Parameters:

value - the value

getNextWriteValue

public Optional<Boolean> getNextWriteValue()

Description copied from interface: WriteChannel

Gets the next write value.

Specified by:

getNextWriteValue in interface WriteChannel<Boolean>

Returns:

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

getOnSetNextWrites

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

Description copied from interface: WriteChannel

Gets the onSetNextWrite callbacks.

Specified by:

getOnSetNextWrites in interface WriteChannel<Boolean>

Overrides:

getOnSetNextWrites in class AbstractReadChannel<OpenemsTypeDoc<Boolean>,Boolean>

Returns:

a List of callbacks

onSetNextWrite

public void onSetNextWrite(ThrowingConsumer<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<Boolean>

Parameters:

callback - the callback