Package com.powsybl.loadflow

Class AbstractNoSpecificParametersLoadFlowProvider

java.lang.Object

com.powsybl.loadflow.AbstractNoSpecificParametersLoadFlowProvider

All Implemented Interfaces:

PlatformConfigNamedProvider, Versionable, LoadFlowProvider

public abstract class AbstractNoSpecificParametersLoadFlowProvider
extends Object
implements LoadFlowProvider

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

PlatformConfigNamedProvider.Finder

Constructor Summary

Constructors

Constructor	Description
AbstractNoSpecificParametersLoadFlowProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	createMapFromSpecificParameters(Extension<LoadFlowParameters> extension)	Create a `Map` of parameter name / `String` value from implementation-specific parameters.
List<Parameter>	getSpecificParameters()	Get the parameters of the parameters extension associated with this provider.
Optional<Class<? extends Extension<LoadFlowParameters>>>	getSpecificParametersClass()	Get specific parameters class.
Optional<ExtensionJsonSerializer>	getSpecificParametersSerializer()	The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.
Optional<Extension<LoadFlowParameters>>	loadSpecificParameters(PlatformConfig config)	Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
Optional<Extension<LoadFlowParameters>>	loadSpecificParameters(Map<String,String> properties)	Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
void	updateSpecificParameters(Extension<LoadFlowParameters> extension, Map<String,String> properties)	Updates implementation-specific parameters from a Map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.loadflow.LoadFlowProvider

run

Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

getName, getPlatformConfigName

Methods inherited from interface com.powsybl.commons.Versionable

getName, getVersion

Constructor Details

AbstractNoSpecificParametersLoadFlowProvider

public AbstractNoSpecificParametersLoadFlowProvider()

Method Details

getSpecificParametersClass

public Optional<Class<? extends Extension<LoadFlowParameters>>> getSpecificParametersClass()

Description copied from interface: LoadFlowProvider

Get specific parameters class.

Specified by:

getSpecificParametersClass in interface LoadFlowProvider

Returns:

The specific parameters class

getSpecificParametersSerializer

public Optional<ExtensionJsonSerializer> getSpecificParametersSerializer()

Description copied from interface: LoadFlowProvider

The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.

Note that the actual serializer type should be ExtensionJsonSerializer<LoadFlowParameters, MyParametersExtension> where MyParametersExtension is the specific parameters class.

Specified by:

getSpecificParametersSerializer in interface LoadFlowProvider

Returns:

The serializer for implementation-specific parameters.

loadSpecificParameters

public Optional<Extension<LoadFlowParameters>> loadSpecificParameters(PlatformConfig config)

Description copied from interface: LoadFlowProvider

Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

Specified by:

loadSpecificParameters in interface LoadFlowProvider

Returns:

The specific parameters read from platform config.

loadSpecificParameters

public Optional<Extension<LoadFlowParameters>> loadSpecificParameters(Map<String,String> properties)

Description copied from interface: LoadFlowProvider

Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

Specified by:

loadSpecificParameters in interface LoadFlowProvider

Returns:

The specific parameters read from Map.

createMapFromSpecificParameters

public Map<String,String> createMapFromSpecificParameters(Extension<LoadFlowParameters> extension)

Description copied from interface: LoadFlowProvider

Create a `Map` of parameter name / `String` value from implementation-specific parameters. If the implementation does not have any specific parameters, `Map` is empty.

Specified by:

createMapFromSpecificParameters in interface LoadFlowProvider

Parameters:

extension - the specific parameters

Returns:

A `Map` of parameter name / `String` value

updateSpecificParameters

public void updateSpecificParameters(Extension<LoadFlowParameters> extension,
 Map<String,String> properties)

Description copied from interface: LoadFlowProvider

Updates implementation-specific parameters from a Map.

Specified by:

updateSpecificParameters in interface LoadFlowProvider

getSpecificParameters

public List<Parameter> getSpecificParameters()

Description copied from interface: LoadFlowProvider

Get the parameters of the parameters extension associated with this provider.

Specified by:

getSpecificParameters in interface LoadFlowProvider

Returns:

the parameters of the parameters extension associated with this provider.