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
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 ClassesModifier and TypeClassDescriptionstatic class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal List<ChannelAddress>
final List<CreateComponentConfigRequest>
static final String
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
ConstructorsConstructorDescriptionExecuteSimulationRequest
(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 TypeMethodDescriptionstatic ExecuteSimulationRequest
CreateExecuteSimulationRequest
from a templateJsonrpcRequest
.com.google.gson.JsonObject
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 Details
-
METHOD
- See Also:
-
components
-
clock
-
profiles
-
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 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
-