Package io.openems.edge.io.weidmueller

Class FieldbusChannelId

java.lang.Object

io.openems.edge.io.weidmueller.FieldbusChannelId

All Implemented Interfaces:

ChannelId

public class FieldbusChannelId
extends Object
implements ChannelId

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.common.channel.ChannelId

ChannelId.ChannelIdImpl

Constructor Summary

Constructors

Constructor	Description
FieldbusChannelId(String name, OpenemsTypeDoc<?> doc)

Method Summary

Modifier and Type	Method	Description
OpenemsTypeDoc<?>	doc()	Gets the Channel Doc for this ChannelId.
static final FieldbusChannelId	forDigitalInput(int module, int index)	Factory for Digital-Input Channel-ID.
static final FieldbusChannelId	forDigitalOutput(int module, int index)	Factory for Digital-Output Channel-ID.
String	name()	Gets the name in format CaseFormat.UPPER_UNDERSCORE.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.common.channel.ChannelId

id

Constructor Details

FieldbusChannelId

public FieldbusChannelId(String name,
 OpenemsTypeDoc<?> doc)

Method Details

forDigitalInput

public static final FieldbusChannelId forDigitalInput(int module,
 int index)

Factory for Digital-Input Channel-ID.

Parameters:

module - the module number

index - the index within the module

Returns:

the FieldbusChannelId

forDigitalOutput

public static final FieldbusChannelId forDigitalOutput(int module,
 int index)

Factory for Digital-Output Channel-ID.

Parameters:

module - the module number

index - the index within the module

Returns:

the FieldbusChannelId

name

public String name()

Description copied from interface: ChannelId

Gets the name in format CaseFormat.UPPER_UNDERSCORE. This is available by default for an Enum.

Names starting with underscore ("_") are reserved for internal usage.

Specified by:

name in interface ChannelId

Returns:

the name

doc

public OpenemsTypeDoc<?> doc()

Description copied from interface: ChannelId

Gets the Channel Doc for this ChannelId.

Specified by:

doc in interface ChannelId

Returns:

the Channel-Doc