Package com.powsybl.dynamicsimulation.json

Class JsonDynamicSimulationParameters

java.lang.Object

com.powsybl.dynamicsimulation.json.JsonDynamicSimulationParameters

public final class JsonDynamicSimulationParameters
extends Object

Provides methods to read and write DynamicSimulationParameters from and to JSON.

Author:

Marcos de Miguel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonDynamicSimulationParameters.ExtensionSerializer<E extends Extension<DynamicSimulationParameters>>	A configuration loader interface for the DynamicSimulationParameters extensions loaded from the platform configuration

Method Summary

Modifier and Type	Method	Description
static DynamicSimulationParameters	deserialize(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext context)	Low level deserialization method, to be used for instance for updating load flow parameters nested in another object.
static DynamicSimulationParameters	deserialize(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext context, DynamicSimulationParameters parameters)	Low level deserialization method, to be used for instance for reading load flow parameters nested in another object.
static ExtensionProviders<JsonDynamicSimulationParameters.ExtensionSerializer>	getExtensionSerializers()	Gets the known extension serializers.
static DynamicSimulationParameters	read(InputStream jsonStream)	Reads parameters from a JSON file (will NOT rely on platform config).
static DynamicSimulationParameters	read(Path jsonFile)	Reads parameters from a JSON file (will NOT rely on platform config).
static void	serialize(DynamicSimulationParameters parameters, com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider)	Low level serialization method, to be used for instance for writing load flow parameters nested in another object.
static DynamicSimulationParameters	update(DynamicSimulationParameters parameters, InputStream jsonStream)	Updates parameters by reading the content of a JSON stream.
static DynamicSimulationParameters	update(DynamicSimulationParameters parameters, Path jsonFile)	Updates parameters by reading the content of a JSON file.
static void	write(DynamicSimulationParameters parameters, OutputStream outputStream)	Writes parameters as JSON to an output stream.
static void	write(DynamicSimulationParameters parameters, Path jsonFile)	Writes parameters as JSON to a file.

Methods inherited from class java.lang.Object

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

Method Detail

getExtensionSerializers

public static ExtensionProviders<JsonDynamicSimulationParameters.ExtensionSerializer> getExtensionSerializers()

Gets the known extension serializers.

read

public static DynamicSimulationParameters read(Path jsonFile)

Reads parameters from a JSON file (will NOT rely on platform config).

read

public static DynamicSimulationParameters read(InputStream jsonStream)

Reads parameters from a JSON file (will NOT rely on platform config).

update

public static DynamicSimulationParameters update(DynamicSimulationParameters parameters,
                                                 Path jsonFile)

Updates parameters by reading the content of a JSON file.

update

public static DynamicSimulationParameters update(DynamicSimulationParameters parameters,
                                                 InputStream jsonStream)

Updates parameters by reading the content of a JSON stream.

write

public static void write(DynamicSimulationParameters parameters,
                         Path jsonFile)

Writes parameters as JSON to a file.

write

public static void write(DynamicSimulationParameters parameters,
                         OutputStream outputStream)

Writes parameters as JSON to an output stream.

deserialize

public static DynamicSimulationParameters deserialize(com.fasterxml.jackson.core.JsonParser parser,
                                                      com.fasterxml.jackson.databind.DeserializationContext context,
                                                      DynamicSimulationParameters parameters)
                                               throws IOException

Low level deserialization method, to be used for instance for reading load flow parameters nested in another object.

Throws:

IOException

deserialize

public static DynamicSimulationParameters deserialize(com.fasterxml.jackson.core.JsonParser parser,
                                                      com.fasterxml.jackson.databind.DeserializationContext context)
                                               throws IOException

Low level deserialization method, to be used for instance for updating load flow parameters nested in another object.

Throws:

IOException

serialize

public static void serialize(DynamicSimulationParameters parameters,
                             com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                             com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
                      throws IOException

Low level serialization method, to be used for instance for writing load flow parameters nested in another object.

Throws:

IOException