Package io.openems.edge.common.channel

Class StringWriteChannel

java.lang.Object

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

io.openems.edge.common.channel.StringReadChannel

io.openems.edge.common.channel.StringWriteChannel

All Implemented Interfaces:

Channel<String>, WriteChannel<String>

public class StringWriteChannel
extends StringReadChannel
implements WriteChannel<String>

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

Constructor	Description
StringWriteChannel(OpenemsComponent component, ChannelId channelId, StringDoc channelDoc)

Method Summary

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

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

_setNextValue, 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

StringWriteChannel

public StringWriteChannel(OpenemsComponent component,
 ChannelId channelId,
 StringDoc channelDoc)

Method Details

_setNextWriteValue

@Deprecated
public void _setNextWriteValue(String value)

Deprecated.

Internal method. Do not call directly.

Specified by:

_setNextWriteValue in interface WriteChannel<String>

Parameters:

value - the value as String

getNextWriteValue

public Optional<String> getNextWriteValue()

Description copied from interface: WriteChannel

Gets the next write value.

Specified by:

getNextWriteValue in interface WriteChannel<String>

Returns:

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

getOnSetNextWrites

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

Description copied from interface: WriteChannel

Gets the onSetNextWrite callbacks.

Specified by:

getOnSetNextWrites in interface WriteChannel<String>

Overrides:

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

Returns:

a List of callbacks

onSetNextWrite

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

Parameters:

callback - the callback