Package io.openems.edge.simulator.app

Class ExecuteSimulationRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.simulator.app.ExecuteSimulationRequest

public class ExecuteSimulationRequest
extends JsonrpcRequest

Executes a simulation.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "executeSimulation",
   "params": {
     components: {
       "componentId": {
           "factoryPid": string,
         "properties": [{
           "name": string,
           "value": any
         }]
       },
       "clock": {
         "start": "yyyy-mm-ddTHH:MM:00.00Z", // ISO_INSTANT
         "end": "yyyy-mm-ddTHH:MM:00.00Z", // ISO_INSTANT
         "timeleap": number [s],
         "executeCycleTwice": boolean // Execute every Cycle twice to simulate immediate execution
       },
       "profiles": {
         "meter0/ActivePower": number[],
       },
       "collect": [
         "_sum/GridActivePower",... // Channels to be collected for response
       ]
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecuteSimulationRequest.Clock
static class	ExecuteSimulationRequest.Profile

Field Summary

Fields

Modifier and Type	Field	Description
final ExecuteSimulationRequest.Clock	clock
final List<ChannelAddress>	collects
final List<CreateComponentConfigRequest>	components
static final String	METHOD
final Map<String,ExecuteSimulationRequest.Profile>	profiles

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
ExecuteSimulationRequest(JsonrpcRequest request, List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, Map<String,ExecuteSimulationRequest.Profile> profiles, List<ChannelAddress> collects)
ExecuteSimulationRequest(List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, Map<String,ExecuteSimulationRequest.Profile> profiles, List<ChannelAddress> collects)

Method Summary

Modifier and Type	Method	Description
static ExecuteSimulationRequest	from(JsonrpcRequest r)	Create ExecuteSimulationRequest from a template JsonrpcRequest.
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

components

public final List<CreateComponentConfigRequest> components

clock

public final ExecuteSimulationRequest.Clock clock

profiles

public final Map<String,ExecuteSimulationRequest.Profile> profiles

collects

public final List<ChannelAddress> collects

Constructor Details

ExecuteSimulationRequest

public ExecuteSimulationRequest(List<CreateComponentConfigRequest> components,
 ExecuteSimulationRequest.Clock clock,
 Map<String,ExecuteSimulationRequest.Profile> profiles,
 List<ChannelAddress> collects)

ExecuteSimulationRequest

public ExecuteSimulationRequest(JsonrpcRequest request,
 List<CreateComponentConfigRequest> components,
 ExecuteSimulationRequest.Clock clock,
 Map<String,ExecuteSimulationRequest.Profile> profiles,
 List<ChannelAddress> collects)

Method Details

from

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

Create ExecuteSimulationRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the ExecuteSimulationRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

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