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>
-
Field Summary
Fields inherited from class io.openems.edge.common.channel.internal.AbstractReadChannel
parent
Fields inherited from interface io.openems.edge.common.channel.Channel
NO_OF_PAST_VALUES
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BooleanWriteChannel
(OpenemsComponent component, ChannelId channelId, BooleanDoc channelDoc) -
Method Summary
Modifier and TypeMethodDescriptionvoid
_setNextWriteValue
(Boolean value) Deprecated.Gets the next write value.Gets the onSetNextWrite callbacks.void
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.Internal method. Do not call directly.- Specified by:
_setNextWriteValue
in interfaceWriteChannel<Boolean>
- Parameters:
value
- the value
-
getNextWriteValue
Description copied from interface:WriteChannel
Gets the next write value.- Specified by:
getNextWriteValue
in interfaceWriteChannel<Boolean>
- Returns:
- the next write value; not-present if no write value had been set
-
getOnSetNextWrites
Description copied from interface:WriteChannel
Gets the onSetNextWrite callbacks.- Specified by:
getOnSetNextWrites
in interfaceWriteChannel<Boolean>
- Overrides:
getOnSetNextWrites
in classAbstractReadChannel<OpenemsTypeDoc<Boolean>,
Boolean> - Returns:
- a List of callbacks
-
onSetNextWrite
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 interfaceWriteChannel<Boolean>
- Parameters:
callback
- the callback
-