Load.java
/**
* Copyright (c) 2016, All partners of the iTesla project (http://www.itesla-project.eu/consortium)
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
* SPDX-License-Identifier: MPL-2.0
*/
package com.powsybl.iidm.network;
import java.util.Optional;
/**
* A constant power load (fixed p0 and q0).
* <p>p0 and q0 are given at the nominal voltage of the voltage level to which
* the load is connected (l.getTerminal().getVoltageLevel().getNominalV()).
*
* <p>
* Characteristics
* </p>
*
* <table style="border: 1px solid black; border-collapse: collapse">
* <thead>
* <tr>
* <th style="border: 1px solid black">Attribute</th>
* <th style="border: 1px solid black">Type</th>
* <th style="border: 1px solid black">Unit</th>
* <th style="border: 1px solid black">Required</th>
* <th style="border: 1px solid black">Default value</th>
* <th style="border: 1px solid black">Description</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td style="border: 1px solid black">Id</td>
* <td style="border: 1px solid black">String</td>
* <td style="border: 1px solid black"> - </td>
* <td style="border: 1px solid black">yes</td>
* <td style="border: 1px solid black"> - </td>
* <td style="border: 1px solid black">Unique identifier of the load</td>
* </tr>
* <tr>
* <td style="border: 1px solid black">Name</td>
* <td style="border: 1px solid black">String</td>
* <td style="border: 1px solid black">-</td>
* <td style="border: 1px solid black">yes</td>
* <td style="border: 1px solid black"> - </td>
* <td style="border: 1px solid black">Human-readable name of the load</td>
* </tr>
* <tr>
* <td style="border: 1px solid black">LoadType</td>
* <td style="border: 1px solid black">LoadType</td>
* <td style="border: 1px solid black">-</td>
* <td style="border: 1px solid black">no</td>
* <td style="border: 1px solid black"> UNDEFINED </td>
* <td style="border: 1px solid black">The type of load</td>
* </tr>
* <tr>
* <td style="border: 1px solid black">P0</td>
* <td style="border: 1px solid black">double</td>
* <td style="border: 1px solid black">MW</td>
* <td style="border: 1px solid black">yes</td>
* <td style="border: 1px solid black"> - </td>
* <td style="border: 1px solid black">The active power setpoint</td>
* </tr>
* <tr>
* <td style="border: 1px solid black">Q0</td>
* <td style="border: 1px solid black">double</td>
* <td style="border: 1px solid black">MVar</td>
* <td style="border: 1px solid black">yes</td>
* <td style="border: 1px solid black"> - </td>
* <td style="border: 1px solid black">The reactive power setpoint</td>
* </tr>
* </tbody>
* </table>
*
* <p>To create a load, see {@link LoadAdder}
*
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
* @see LoadAdder
*/
public interface Load extends Injection<Load> {
LoadType getLoadType();
Load setLoadType(LoadType loadType);
/**
* Get the constant active power in MW.
* <p>Depends on the working variant.
* @see VariantManager
*/
double getP0();
/**
* Set the constant active power in MW.
* <p>Depends on the working variant.
* @see VariantManager
*/
Load setP0(double p0);
/**
* Get the constant reactive power in MVar.
* <p>Depends on the working variant.
* @see VariantManager
*/
double getQ0();
/**
* Set the constant reactive power in MVar.
* <p>Depends on the working variant.
* @see VariantManager
*/
Load setQ0(double q0);
@Override
default IdentifiableType getType() {
return IdentifiableType.LOAD;
}
Optional<LoadModel> getModel();
}