com.powsybl.action.StaticVarCompensatorAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-action-api Show documentation
Powsybl action API
The newest version!
/**
 * Copyright (c) 2023, RTE (http://www.rte-france.com)
 * 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.action;

import com.powsybl.iidm.network.StaticVarCompensator;

import java.util.Objects;
import java.util.Optional;
import java.util.OptionalDouble;

/**
 * An action to:
 * 
 *     change the regulationMode of a static var compensator, three options are available VOLTAGE, REACTIVE_POWER or OFF
 *     change voltageSetPoint to change the voltage setpoint if the regulation mode is set to VOLTAGE (kV) 
 *     change reactivePowerSetpoint to change the reactive power setpoint if the regulation mode is set to REACTIVE_POWER (MVAR)
 * 
 *
 * @author Etienne Lesot {@literal }
 */
public class StaticVarCompensatorAction extends AbstractAction {

    public static final String NAME = "STATIC_VAR_COMPENSATOR";
    private final String staticVarCompensatorId;
    private final StaticVarCompensator.RegulationMode regulationMode;
    private final Double voltageSetpoint;
    private final Double reactivePowerSetpoint;

    protected StaticVarCompensatorAction(String id, String staticVarCompensatorId,
                                         StaticVarCompensator.RegulationMode regulationMode,
                                         Double voltageSetpoint, Double reactivePowerSetpoint) {
        super(id);
        this.staticVarCompensatorId = Objects.requireNonNull(staticVarCompensatorId);
        this.regulationMode = regulationMode;
        this.voltageSetpoint = voltageSetpoint;
        this.reactivePowerSetpoint = reactivePowerSetpoint;
    }

    @Override
    public String getType() {
        return NAME;
    }

    public String getStaticVarCompensatorId() {
        return staticVarCompensatorId;
    }

    public Optional getRegulationMode() {
        return Optional.ofNullable(regulationMode);
    }

    public OptionalDouble getVoltageSetpoint() {
        return voltageSetpoint == null ? OptionalDouble.empty() : OptionalDouble.of(voltageSetpoint);
    }

    public OptionalDouble getReactivePowerSetpoint() {
        return reactivePowerSetpoint == null ? OptionalDouble.empty() : OptionalDouble.of(reactivePowerSetpoint);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }
        StaticVarCompensatorAction that = (StaticVarCompensatorAction) o;
        return Objects.equals(staticVarCompensatorId, that.staticVarCompensatorId)
                && regulationMode == that.regulationMode
                && Objects.equals(voltageSetpoint, that.voltageSetpoint)
                && Objects.equals(reactivePowerSetpoint, that.reactivePowerSetpoint);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), staticVarCompensatorId, regulationMode, voltageSetpoint, reactivePowerSetpoint);
    }
}