Package io.openems.backend.common.jsonrpc.request

Class GetEdgesChannelsValuesRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.backend.common.jsonrpc.request.GetEdgesChannelsValuesRequest

public class GetEdgesChannelsValuesRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'getChannelsValues'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "getEdgesChannelsValues",
   "params": {
     "ids": string[] // Edge-IDs
     "channels": string[] // Channel-IDs
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
GetEdgesChannelsValuesRequest()

Method Summary

Modifier and Type	Method	Description
void	addChannel(ChannelAddress address)	Adds a ChannelAddress.
void	addEdgeId(String edgeId)	Adds a Edge-ID.
static GetEdgesChannelsValuesRequest	from(JsonrpcRequest r)	Create GetEdgesChannelsValuesRequest from a template JsonrpcRequest.
TreeSet<ChannelAddress>	getChannels()	Gets the ChannelAddresses.
TreeSet<String>	getEdgeIds()	Gets the Edge-IDs.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

getId, getTimeout, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

getFullyQualifiedMethod, getMethod

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

GetEdgesChannelsValuesRequest

public GetEdgesChannelsValuesRequest()

Method Details

from

public static GetEdgesChannelsValuesRequest from(JsonrpcRequest r)
                                          throws OpenemsError.OpenemsNamedException

Create GetEdgesChannelsValuesRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the GetEdgesChannelsValuesRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

addEdgeId

public void addEdgeId(String edgeId)

Adds a Edge-ID.

Parameters:

edgeId - the Edge-ID

getEdgeIds

public TreeSet<String> getEdgeIds()

Gets the Edge-IDs.

Returns:

set of Edge-IDs.

addChannel

public void addChannel(ChannelAddress address)

Adds a ChannelAddress.

Parameters:

address - the ChannelAddress

getChannels

public TreeSet<ChannelAddress> getChannels()

Gets the ChannelAddresses.

Returns:

the ChannelAddresses

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject