Package io.openems.edge.common.channel
Class FloatWriteChannel
java.lang.Object
io.openems.edge.common.channel.internal.AbstractReadChannel<OpenemsTypeDoc<Float>,Float>
io.openems.edge.common.channel.FloatReadChannel
io.openems.edge.common.channel.FloatWriteChannel
- All Implemented Interfaces:
Channel<Float>
,WriteChannel<Float>
-
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
ModifierConstructorDescriptionprotected
FloatWriteChannel
(OpenemsComponent component, ChannelId channelId, FloatDoc channelDoc) -
Method Summary
Modifier and TypeMethodDescriptionvoid
_setNextWriteValue
(Float 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.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
-
FloatWriteChannel
-
-
Method Details
-
_setNextWriteValue
Deprecated.Internal method. Do not call directly.- Specified by:
_setNextWriteValue
in interfaceWriteChannel<Float>
- Parameters:
value
- the value asFloat
-
getNextWriteValue
Description copied from interface:WriteChannel
Gets the next write value.- Specified by:
getNextWriteValue
in interfaceWriteChannel<Float>
- 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<Float>
- Overrides:
getOnSetNextWrites
in classAbstractReadChannel<OpenemsTypeDoc<Float>,
Float> - 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<Float>
- Parameters:
callback
- the callback
-