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 ExecuteSimulationRequest.Clock
clock
java.util.List<ChannelAddress>
collects
java.util.List<CreateComponentConfigRequest>
components
static java.lang.String
METHOD
java.util.Map<java.lang.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, java.util.List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, java.util.Map<java.lang.String,ExecuteSimulationRequest.Profile> profiles, java.util.List<ChannelAddress> collects)
ExecuteSimulationRequest(java.util.List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, java.util.Map<java.lang.String,ExecuteSimulationRequest.Profile> profiles, java.util.List<ChannelAddress> collects)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExecuteSimulationRequest
from(JsonrpcRequest r)
CreateExecuteSimulationRequest
from a templateJsonrpcRequest
.com.google.gson.JsonObject
getParams()
Gets the paramsJsonObject
of theJsonrpcRequest
.-
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
-
-
-
-
Field Detail
-
METHOD
public static final java.lang.String METHOD
- See Also:
- Constant Field Values
-
components
public final java.util.List<CreateComponentConfigRequest> components
-
clock
public final ExecuteSimulationRequest.Clock clock
-
profiles
public final java.util.Map<java.lang.String,ExecuteSimulationRequest.Profile> profiles
-
collects
public final java.util.List<ChannelAddress> collects
-
-
Constructor Detail
-
ExecuteSimulationRequest
public ExecuteSimulationRequest(java.util.List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, java.util.Map<java.lang.String,ExecuteSimulationRequest.Profile> profiles, java.util.List<ChannelAddress> collects)
-
ExecuteSimulationRequest
public ExecuteSimulationRequest(JsonrpcRequest request, java.util.List<CreateComponentConfigRequest> components, ExecuteSimulationRequest.Clock clock, java.util.Map<java.lang.String,ExecuteSimulationRequest.Profile> profiles, java.util.List<ChannelAddress> collects)
-
-
Method Detail
-
from
public static ExecuteSimulationRequest from(JsonrpcRequest r) throws OpenemsError.OpenemsNamedException
CreateExecuteSimulationRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
ExecuteSimulationRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getParams
public com.google.gson.JsonObject getParams()
Description copied from class:AbstractJsonrpcRequest
Gets the paramsJsonObject
of theJsonrpcRequest
.- Specified by:
getParams
in classAbstractJsonrpcRequest
- Returns:
- the params as
JsonObject
-
-