Package io.openems.common.types

Class EdgeConfig.Component.Channel

java.lang.Object

io.openems.common.types.EdgeConfig.Component.Channel

Enclosing class:

EdgeConfig.Component

public static class EdgeConfig.Component.Channel
extends Object

Represents a Channel of an OpenEMS Component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EdgeConfig.Component.Channel.ChannelDetail
static class	EdgeConfig.Component.Channel.ChannelDetailEnum	Channel-Details for EnumChannel.
static class	EdgeConfig.Component.Channel.ChannelDetailOpenemsType	Channel-Details for OpenemsType-Channel.
static class	EdgeConfig.Component.Channel.ChannelDetailState	Channel-Details for StateChannel.

Constructor Summary

Constructors

Constructor	Description
Channel(String id, OpenemsType type, AccessMode accessMode, String text, Unit unit, EdgeConfig.Component.Channel.ChannelDetail detail)

Method Summary

Modifier and Type	Method	Description
static EdgeConfig.Component.Channel	fromJson(String channelId, com.google.gson.JsonElement json)	Creates a Channel from JSON.
AccessMode	getAccessMode()	Gets the AccessMode of the Channel.
EdgeConfig.Component.Channel.ChannelDetail	getDetail()	Gets the specific EdgeConfig.Component.Channel.ChannelDetail object of the Channel.
String	getId()	Gets the Channel-ID.
String	getText()	Gets the descriptive text of the Channel.
OpenemsType	getType()	Gets the OpenemsType of the Channel.
Unit	getUnit()	Gets the Unit of the Channel.
com.google.gson.JsonObject	toJson()	Gets the JSON representation of this Channel.

Methods inherited from class java.lang.Object

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

Constructor Details

Channel

public Channel(String id,
 OpenemsType type,
 AccessMode accessMode,
 String text,
 Unit unit,
 EdgeConfig.Component.Channel.ChannelDetail detail)

Method Details

fromJson

public static EdgeConfig.Component.Channel fromJson(String channelId,
 com.google.gson.JsonElement json)
                                             throws OpenemsError.OpenemsNamedException

Creates a Channel from JSON.

Parameters:

channelId - the Channel-ID

json - the JSON

Returns:

the Channel

Throws:

OpenemsError.OpenemsNamedException - on error

getId

public String getId()

Gets the Channel-ID.

Returns:

the Channel-ID.

getType

public OpenemsType getType()

Gets the OpenemsType of the Channel.

Returns:

the OpenemsType

getAccessMode

public AccessMode getAccessMode()

Gets the AccessMode of the Channel.

Returns:

the AccessMode

getText

public String getText()

Gets the descriptive text of the Channel.

Returns:

the descriptive text

getUnit

public Unit getUnit()

Gets the Unit of the Channel.

Returns:

the Unit

getDetail

public EdgeConfig.Component.Channel.ChannelDetail getDetail()

Gets the specific EdgeConfig.Component.Channel.ChannelDetail object of the Channel.

Returns:

the EdgeConfig.Component.Channel.ChannelDetail

toJson

public com.google.gson.JsonObject toJson()

Gets the JSON representation of this Channel.

Returns:

a JsonObject