Package com.powsybl.loadflow.json

Class JsonLoadFlowParameters

java.lang.Object

com.powsybl.loadflow.json.JsonLoadFlowParameters

public final class JsonLoadFlowParameters
extends Object

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

Author:

Sylvain Leclerc

Nested Class Summary

Nested Classes

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

Method Summary

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

Gets the known extension serializers.

read

public static LoadFlowParameters read(Path jsonFile)

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

read

public static LoadFlowParameters read(InputStream jsonStream)

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

update

public static LoadFlowParameters update(LoadFlowParameters parameters,
                                        Path jsonFile)

Updates parameters by reading the content of a JSON file.

update

public static LoadFlowParameters update(LoadFlowParameters parameters,
                                        InputStream jsonStream)

Updates parameters by reading the content of a JSON stream.

write

public static void write(LoadFlowParameters parameters,
                         Path jsonFile)

Writes parameters as JSON to a file.

write

public static void write(LoadFlowParameters parameters,
                         OutputStream outputStream)

Writes parameters as JSON to an output stream.

deserialize

public static LoadFlowParameters deserialize(com.fasterxml.jackson.core.JsonParser parser,
                                             com.fasterxml.jackson.databind.DeserializationContext context,
                                             LoadFlowParameters 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 LoadFlowParameters 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(LoadFlowParameters 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