Package io.openems.edge.common.channel.internal

Class AbstractReadChannel<D extends AbstractDoc<T>,T>

java.lang.Object

io.openems.edge.common.channel.internal.AbstractReadChannel<D,T>

All Implemented Interfaces:

Channel<T>

Direct Known Subclasses:

BooleanReadChannel, DoubleReadChannel, EnumReadChannel, FloatReadChannel, IntegerReadChannel, LongReadChannel, ShortReadChannel, StringReadChannel

public abstract class AbstractReadChannel<D extends AbstractDoc<T>,T>
extends Object
implements Channel<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final OpenemsComponent	parent

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

MAX_AGE_OF_PAST_VALUES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReadChannel(OpenemsType type, OpenemsComponent parent, ChannelId channelId, D channelDoc)

Method Summary

Modifier and Type	Method	Description
void	_setNextValue(T value)	Deprecated.
ChannelAddress	address()	Gets the address of this Channel.
D	channelDoc()	Gets the ChannelDoc of this Channel.
ChannelId	channelId()	Gets the ChannelId of this Channel.
void	deactivate()	Deactivates the Channel and makes sure all callbacks are released for garbe collection to avoid memory-leaks.
OpenemsComponent	getComponent()	Gets the OpenemsComponent this Channel belongs to.
<SOURCE> SOURCE	getMetaInfo()	Gets the meta information object.
Value<T>	getNextValue()	Gets the 'next value'.
protected List<ThrowingConsumer<T,OpenemsError.OpenemsNamedException>>	getOnSetNextWrites()
TreeMap<LocalDateTime,Value<T>>	getPastValues()	Gets the past values for this Channel.
OpenemsType	getType()	Gets the type of this Channel, e.g.
void	nextProcessImage()	Switches to the next process image, i.e.
BiConsumer<Value<T>,Value<T>>	onChange(BiConsumer<Value<T>,Value<T>> callback)	Add an onChange callback.
Consumer<Value<T>>	onSetNextValue(Consumer<Value<T>> callback)	Add an onSetNextValue callback.
Consumer<Value<T>>	onUpdate(Consumer<Value<T>> callback)	Add an onUpdate callback.
void	removeOnChangeCallback(BiConsumer<?,?> callback)	Removes an onChange callback.
void	removeOnSetNextValueCallback(Consumer<?> callback)	Removes an onSetNextValue callback.
void	removeOnUpdateCallback(Consumer<Value<?>> callback)	Removes an onUpdate callback.
<SOURCE> void	setMetaInfo(SOURCE source)	Sets an object that holds meta information about the Channel, e.g.
String	toString()
Value<T>	value()	Gets the currently active value, wrapped in a @{link 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

Field Details

parent

protected final OpenemsComponent parent

Constructor Details

AbstractReadChannel

protected AbstractReadChannel(OpenemsType type,
 OpenemsComponent parent,
 ChannelId channelId,
 D channelDoc)

Method Details

deactivate

public void deactivate()

Description copied from interface: Channel

Deactivates the Channel and makes sure all callbacks are released for garbe collection to avoid memory-leaks.

Specified by:

deactivate in interface Channel<D extends AbstractDoc<T>>

channelDoc

public D channelDoc()

Description copied from interface: Channel

Gets the ChannelDoc of this Channel.

Specified by:

channelDoc in interface Channel<D extends AbstractDoc<T>>

Returns:

the ChannelDoc

channelId

public ChannelId channelId()

Description copied from interface: Channel

Gets the ChannelId of this Channel.

Specified by:

channelId in interface Channel<D extends AbstractDoc<T>>

Returns:

the ChannelId

getComponent

public OpenemsComponent getComponent()

Description copied from interface: Channel

Gets the OpenemsComponent this Channel belongs to.

Specified by:

getComponent in interface Channel<D extends AbstractDoc<T>>

Returns:

the OpenemsComponent

nextProcessImage

public void nextProcessImage()

Description copied from interface: Channel

Switches to the next process image, i.e. copies the "next"-value into "current"-value.

Specified by:

nextProcessImage in interface Channel<D extends AbstractDoc<T>>

address

public ChannelAddress address()

Description copied from interface: Channel

Gets the address of this Channel.

Specified by:

address in interface Channel<D extends AbstractDoc<T>>

Returns:

the ChannelAddress

getType

public OpenemsType getType()

Description copied from interface: Channel

Gets the type of this Channel, e.g. INTEGER, BOOLEAN,..

Specified by:

getType in interface Channel<D extends AbstractDoc<T>>

Returns:

the OpenemsType

_setNextValue

@Deprecated
public void _setNextValue(T value)

Deprecated.

Sets the next value. Internal method. Do not call directly.

If the Unit of the Channel is cumulated and 'value' is null, it is silently ignored. Cumulated values must be steadily increasing and should never get reset to null. See Unit.

Specified by:

_setNextValue in interface Channel<D extends AbstractDoc<T>>

Parameters:

value - the next value

getNextValue

public Value<T> getNextValue()

Description copied from interface: Channel

Gets the 'next value'.

Note that usually you should prefer the value() method.

Specified by:

getNextValue in interface Channel<D extends AbstractDoc<T>>

Returns:

the 'next value', never null

value

public Value<T> value()
               throws IllegalArgumentException

Description copied from interface: Channel

Gets the currently active value, wrapped in a @{link Value}.

Specified by:

value in interface Channel<D extends AbstractDoc<T>>

Returns:

the active value, never null

Throws:

IllegalArgumentException - if value cannot be accessed, e.g. because the Channel is Write-Only.

toString

public String toString()

Overrides:

toString in class Object

onUpdate

public Consumer<Value<T>> onUpdate(Consumer<Value<T>> callback)

Description copied from interface: Channel

Add an onUpdate callback. It is called, after the active value was updated by nextProcessImage().

Specified by:

onUpdate in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - the callback

Returns:

the same callback for fluent coding

removeOnUpdateCallback

public void removeOnUpdateCallback(Consumer<Value<?>> callback)

Description copied from interface: Channel

Removes an onUpdate callback.

Specified by:

removeOnUpdateCallback in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - the callback Consumer

See Also:

• Channel.onUpdate(Consumer)

onSetNextValue

public Consumer<Value<T>> onSetNextValue(Consumer<Value<T>> callback)

Description copied from interface: Channel

Add an onSetNextValue callback. It is called, after a new NextValue was set. Note that usually you should prefer the onUpdate() callback.

Remember to remove the callback using Channel.removeOnSetNextValueCallback(Consumer) once it is not needed anymore, e.g. on deactivate().

Specified by:

onSetNextValue in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - the callback Consumer

Returns:

the callback to enable fluent programming

See Also:

• Channel.onUpdate(java.util.function.Consumer<io.openems.edge.common.channel.value.Value<T>>)

removeOnSetNextValueCallback

public void removeOnSetNextValueCallback(Consumer<?> callback)

Description copied from interface: Channel

Removes an onSetNextValue callback.

Specified by:

removeOnSetNextValueCallback in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - the callback Consumer

See Also:

• Channel.onSetNextValue(Consumer)

onChange

public BiConsumer<Value<T>,Value<T>> onChange(BiConsumer<Value<T>,Value<T>> callback)

Description copied from interface: Channel

Add an onChange callback. It is called, after a new, different active value was set by nextProcessImage().

Specified by:

onChange in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - old value and new value

Returns:

the same callback for fluent coding

removeOnChangeCallback

public void removeOnChangeCallback(BiConsumer<?,?> callback)

Description copied from interface: Channel

Removes an onChange callback.

Specified by:

removeOnChangeCallback in interface Channel<D extends AbstractDoc<T>>

Parameters:

callback - the callback BiConsumer

See Also:

• Channel.onChange(BiConsumer)

getOnSetNextWrites

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

getPastValues

public TreeMap<LocalDateTime,Value<T>> getPastValues()

Gets the past values for this Channel.

Specified by:

getPastValues in interface Channel<D extends AbstractDoc<T>>

Returns:

a map of recording time and historic value at that time

setMetaInfo

public <SOURCE> void setMetaInfo(SOURCE source)
                          throws IllegalArgumentException

Description copied from interface: Channel

Sets an object that holds meta information about the Channel, e.g. a read source or write target of this Channel, like a Modbus Register or REST-Api endpoint address. Defaults to null.

Specified by:

setMetaInfo in interface Channel<D extends AbstractDoc<T>>

Type Parameters:

SOURCE - the type of the meta info

Parameters:

source - the meta info object

Throws:

IllegalArgumentException - if there is already a different meta-info registered with the Channel

getMetaInfo

public <SOURCE> SOURCE getMetaInfo()

Description copied from interface: Channel

Gets the meta information object. Defaults to null.

Specified by:

getMetaInfo in interface Channel<D extends AbstractDoc<T>>

Type Parameters:

SOURCE - the type of the meta info attachment

Returns:

the meta info object