com.powsybl.action.LoadAction 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;

import com.powsybl.iidm.modification.LoadModification;
import com.powsybl.iidm.modification.NetworkModification;

import java.util.Objects;

/**
 * An action to:
 * 
 *     change the P0 of a load, either by specifying a new absolute value (MW) or a relative change (MW).
 *     change the Q0 of a load, either by specifying a new absolute value (MVar) or a relative change (MVar).
 * 
 *
 * @author Anne Tilloy {@literal }
 */
public class LoadAction extends AbstractLoadAction {

    public static final String NAME = "LOAD";

    private final String loadId;

    /**
     * @param id                 the id of the action.
     * @param loadId             the id of the load on which the action would be applied.
     * @param relativeValue      True if the load P0 and/or Q0 variation is relative, False if absolute.
     * @param activePowerValue   The new load P0 (MW) if relativeValue equals False, otherwise the relative variation of load P0 (MW).
     * @param reactivePowerValue The new load Q0 (MVar) if relativeValue equals False, otherwise the relative variation of load Q0 (MVar).
     */
    LoadAction(String id, String loadId, boolean relativeValue, Double activePowerValue, Double reactivePowerValue) {
        super(id, relativeValue, activePowerValue, reactivePowerValue);
        this.loadId = Objects.requireNonNull(loadId);
    }

    public String getLoadId() {
        return loadId;
    }

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

    @Override
    public NetworkModification toModification() {
        return new LoadModification(
                getLoadId(),
                isRelativeValue(),
                getActivePowerValue().stream().boxed().findFirst().orElse(null),
                getReactivePowerValue().stream().boxed().findFirst().orElse(null)
        );
    }

    @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;
        }
        LoadAction that = (LoadAction) o;
        return Objects.equals(loadId, that.loadId);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), loadId);
    }
}