Package io.openems.edge.common.channel

Interface WriteChannel<T>

All Superinterfaces:

Channel<T>

All Known Implementing Classes:

BooleanWriteChannel, DoubleWriteChannel, EnumWriteChannel, FloatWriteChannel, IntegerWriteChannel, LongWriteChannel, ShortWriteChannel, StringWriteChannel

public interface WriteChannel<T>
extends Channel<T>

Field Summary

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

NO_OF_PAST_VALUES

Method Summary

Modifier and Type	Method	Description
void	_setNextWriteValue(T value)	Deprecated.
Optional<T>	getNextWriteValue()	Gets the next write value.
default Optional<T>	getNextWriteValueAndReset()	Gets the next write value and resets it.
List<ThrowingConsumer<T,OpenemsError.OpenemsNamedException>>	getOnSetNextWrites()	Gets the onSetNextWrite callbacks.
void	onSetNextWrite(ThrowingConsumer<T,OpenemsError.OpenemsNamedException> callback)	Add an onSetNextWrite callback.
default void	setNextWriteValue(T value)	Updates the 'next' write value of Channel.
default void	setNextWriteValueFromObject(Object value)	Updates the 'next' write value of Channel from an Object value.

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

Method Details

setNextWriteValue

default void setNextWriteValue(T value)
                        throws OpenemsError.OpenemsNamedException

Updates the 'next' write value of Channel.

Parameters:

value - the typed value

Throws:

OpenemsError.OpenemsNamedException - on error

setNextWriteValueFromObject

default void setNextWriteValueFromObject(Object value)
                                  throws OpenemsError.OpenemsNamedException,
IllegalArgumentException

Updates the 'next' write value of Channel from an Object value.

Use this method if the value is not yet in the correct Type. Otherwise use setNextWriteValue(Object) directly.

Parameters:

value - the value as an Object

Throws:

OpenemsError.OpenemsNamedException - on error

IllegalArgumentException - on error

_setNextWriteValue

@Deprecated
void _setNextWriteValue(T value)

Deprecated.

Internal method. Do not call directly.

Parameters:

value - the value

getNextWriteValueAndReset

default Optional<T> getNextWriteValueAndReset()

Gets the next write value and resets it.

Returns:

the next write value

getNextWriteValue

Optional<T> getNextWriteValue()

Gets the next write value.

Returns:

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

onSetNextWrite

void onSetNextWrite(ThrowingConsumer<T,OpenemsError.OpenemsNamedException> callback)

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

The callback can throw an OpenemsError.OpenemsNamedException.

Parameters:

callback - the callback

getOnSetNextWrites

List<ThrowingConsumer<T,OpenemsError.OpenemsNamedException>> getOnSetNextWrites()

Gets the onSetNextWrite callbacks.

Returns:

a List of callbacks