com.powsybl.action.GeneratorActionBuilder 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) 2022, 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;

/**
 * @author Anne Tilloy {@literal }
 */
public class GeneratorActionBuilder implements ActionBuilder {

    private String id;
    private String generatorId;
    private Boolean activePowerRelativeValue;
    private Double activePowerValue;
    private Boolean voltageRegulatorOn;
    private Double targetV;
    private Double targetQ;

    @Override
    public String getId() {
        return id;
    }

    @Override
    public GeneratorActionBuilder withNetworkElementId(String generatorId) {
        this.generatorId = generatorId;
        return this;
    }

    @Override
    public GeneratorAction build() {
        if (activePowerRelativeValue != null ^ activePowerValue != null) {
            throw new IllegalArgumentException("For a generator action, both or none of these two attributes must be provided: activePowerValue and activePowerRelativeValue");
        }
        return new GeneratorAction(id, generatorId, activePowerRelativeValue, activePowerValue, voltageRegulatorOn, targetV, targetQ);
    }

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

    public GeneratorActionBuilder withId(String id) {
        this.id = id;
        return this;
    }

    public GeneratorActionBuilder withGeneratorId(String generatorId) {
        return withNetworkElementId(generatorId);
    }

    public GeneratorActionBuilder withActivePowerRelativeValue(boolean activePowerRelativeValue) {
        this.activePowerRelativeValue = activePowerRelativeValue;
        return this;
    }

    public GeneratorActionBuilder withActivePowerValue(double activePowerValue) {
        this.activePowerValue = activePowerValue;
        return this;
    }

    public GeneratorActionBuilder withVoltageRegulatorOn(boolean voltageRegulatorOn) {
        this.voltageRegulatorOn = voltageRegulatorOn;
        return this;
    }

    public GeneratorActionBuilder withTargetV(double targetV) {
        this.targetV = targetV;
        return this;
    }

    public GeneratorActionBuilder withTargetQ(double targetQ) {
        this.targetQ = targetQ;
        return this;
    }
}