Package io.openems.edge.common.channel

Class ChannelUtils

java.lang.Object

io.openems.edge.common.channel.ChannelUtils

public final class ChannelUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static <T extends Record> Optional<T>	getValues(OpenemsComponent component, Class<T> clazz)	Gets a Record with all Channel Values; or empty if at least one Value is not available.
static <T extends Record> T	getValuesOrError(OpenemsComponent component, Class<T> clazz)	Gets a Record with all Channel Values.
static void	setWriteValueIfNotRead(BooleanWriteChannel channel, Boolean value)	Set write value of a BooleanWriteChannel if the read value is not equal.
static void	setWriteValueIfNotRead(EnumWriteChannel channel, OptionsEnum value)	Set write value of a EnumWriteChannel if the read value is not equal.
static void	setWriteValueIfNotRead(IntegerWriteChannel channel, Integer value)	Set write value of a IntegerWriteChannel if the read value is not equal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getValuesOrError

public static <T extends Record> T getValuesOrError(OpenemsComponent component,
 Class<T> clazz)
                                             throws OpenemsException

Gets a Record with all Channel Values.

Type Parameters:

T - the type of the Record. The names of the Members of the Record must match the Channel-Ids of the Component

Parameters:

component - the OpenemsComponent

clazz - the Class of the Record

Returns:

an object of type T

Throws:

OpenemsException - if at least one Value is not available

getValues

public static <T extends Record> Optional<T> getValues(OpenemsComponent component,
 Class<T> clazz)

Gets a Record with all Channel Values; or empty if at least one Value is not available.

Type Parameters:

T - the type of the Record. The names of the Members of the Record must match the Channel-Ids of the Component

Parameters:

component - the OpenemsComponent

clazz - the Class of the Record

Returns:

an Optional object of type T

setWriteValueIfNotRead

public static void setWriteValueIfNotRead(EnumWriteChannel channel,
 OptionsEnum value)
                                   throws OpenemsError.OpenemsNamedException

Set write value of a EnumWriteChannel if the read value is not equal.

Use this method if you do not want to write a Channel on every cycle, but only if the Write-Values differs from the current Read-Value.

Parameters:

channel - the EnumWriteChannel

value - value to be set

Throws:

OpenemsError.OpenemsNamedException - on error

setWriteValueIfNotRead

public static void setWriteValueIfNotRead(IntegerWriteChannel channel,
 Integer value)
                                   throws OpenemsError.OpenemsNamedException

Set write value of a IntegerWriteChannel if the read value is not equal.

Use this method if you do not want to write a Channel on every cycle, but only if the Write-Values differs from the current Read-Value.

Parameters:

channel - the IntegerWriteChannel

value - value to be set

Throws:

OpenemsError.OpenemsNamedException - on error

setWriteValueIfNotRead

public static void setWriteValueIfNotRead(BooleanWriteChannel channel,
 Boolean value)
                                   throws OpenemsError.OpenemsNamedException

Set write value of a BooleanWriteChannel if the read value is not equal.

Use this method if you do not want to write a Channel on every cycle, but only if the Write-Values differs from the current Read-Value.

Parameters:

channel - the BooleanWriteChannel

value - value to be set

Throws:

OpenemsError.OpenemsNamedException - on error