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

Class StateCollectorChannel

java.lang.Object

io.openems.edge.common.channel.internal.AbstractReadChannel<EnumDoc,Integer>

io.openems.edge.common.channel.EnumReadChannel

io.openems.edge.common.channel.internal.StateCollectorChannel

All Implemented Interfaces:

Channel<Integer>

public class StateCollectorChannel
extends EnumReadChannel

Collects the values of all StateChannels. This class is used for the "State" Channel of every OpenEMS Component.

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

Modifier	Constructor	Description
protected	StateCollectorChannel(OpenemsComponent parent, ChannelId channelId, StateCollectorChannelDoc channelDoc)

Method Summary

Modifier and Type	Method	Description
void	addChannel(StateChannel channel)	Adds a Channel to this StateCollector.
String	listStates()	Lists all States as Text.
String	listStates(Level fromLevel)	Lists all States that are at least 'fromLevel' as text.
void	removeChannel(StateChannel channel)	Removes a Channel from this StateCollector.
Value<Integer>	value()	Gets the currently active value, wrapped in a @{link Value}.

Methods inherited from class io.openems.edge.common.channel.EnumReadChannel

_setNextValue

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

address, channelDoc, channelId, deactivate, getComponent, getMetaInfo, getNextValue, getOnSetNextWrites, getPastValues, getType, nextProcessImage, onChange, onSetNextValue, onUpdate, removeOnChangeCallback, removeOnSetNextValueCallback, removeOnUpdateCallback, setMetaInfo, toString

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

Constructor Details

StateCollectorChannel

protected StateCollectorChannel(OpenemsComponent parent,
 ChannelId channelId,
 StateCollectorChannelDoc channelDoc)

Method Details

value

public Value<Integer> value()

Description copied from interface: Channel

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

Specified by:

value in interface Channel<Integer>

Overrides:

value in class AbstractReadChannel<EnumDoc,Integer>

Returns:

the active value, never null

addChannel

public void addChannel(StateChannel channel)

Adds a Channel to this StateCollector.

Parameters:

channel - the Channel

removeChannel

public void removeChannel(StateChannel channel)

Removes a Channel from this StateCollector.

The onChange listener is removed by the Channel.deactivate() method.

Parameters:

channel - the Channel

listStates

public String listStates()

Lists all States as Text.

Returns:

the text

listStates

public String listStates(Level fromLevel)

Lists all States that are at least 'fromLevel' as text.

Parameters:

fromLevel - the minimum Level

Returns:

the text