Package com.powsybl.iidm.modification

Class ConnectGenerator

java.lang.Object

com.powsybl.iidm.modification.AbstractNetworkModification

com.powsybl.iidm.modification.ConnectGenerator

All Implemented Interfaces:

NetworkModification

public final class ConnectGenerator
extends AbstractNetworkModification

Author:

Olivier Perrin <olivier.perrin at rte-france.com>

Field Summary

Fields inherited from class com.powsybl.iidm.modification.AbstractNetworkModification

DEFAULT_IMPACT, EPSILON, impact

Constructor Summary

Constructors

Constructor	Description
ConnectGenerator(String generatorId)

Method Summary

Modifier and Type	Method	Description
void	apply(Network network, NamingStrategy namingStrategy, boolean throwException, ComputationManager computationManager, ReportNode reportNode)	Applies the modification to the given network.
String	getName()	Returns the name of the network modification.
NetworkModificationImpact	hasImpactOnNetwork(Network network)	States if the network modification would change the current state of the network.

Methods inherited from class com.powsybl.iidm.modification.AbstractNetworkModification

apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, areValuesEqual, areValuesEqual, checkVoltageLevel, isValueOutsideRange, logOrThrow, reportOnDryRunStart, reportOnInconclusiveDryRun

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectGenerator

public ConnectGenerator(String generatorId)

Method Details

getName

public String getName()

Description copied from class: AbstractNetworkModification

Returns the name of the network modification. That name corresponds to the type of network modification

Specified by:

getName in class AbstractNetworkModification

Returns:

the name of the network modification

apply

public void apply(Network network,
 NamingStrategy namingStrategy,
 boolean throwException,
 ComputationManager computationManager,
 ReportNode reportNode)

Description copied from interface: NetworkModification

Applies the modification to the given network. If throwException is set to true, then in case of error, an exception will be thrown. Otherwise, computation will continue but the injection will not be added to the network in case of error.

hasImpactOnNetwork

public NetworkModificationImpact hasImpactOnNetwork(Network network)

Description copied from interface: NetworkModification

States if the network modification would change the current state of the network. It has no impact on the network.

Specified by:

hasImpactOnNetwork in interface NetworkModification

Overrides:

hasImpactOnNetwork in class AbstractNetworkModification

Parameters:

network - Network that serves as reference for the impact.

Returns:

True if the network modification would have an impact on the network.