com.farao_community.farao.data.crac_impl.StandardRangeAdderImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of farao-crac-impl Show documentation

Object model for CRAC implementation

There is a newer version: 5.0.0

/*
 * Copyright (c) 2021, 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/.
 */

package com.farao_community.farao.data.crac_impl;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.data.crac_api.range.StandardRange;
import com.farao_community.farao.data.crac_api.range.StandardRangeAdder;
import com.farao_community.farao.data.crac_api.range_action.*;

/**
 * @author Godelaine de Montmorillon {@literal }
 * @author Baptiste Seguinot {@literal }
 */
public class StandardRangeAdderImpl> implements StandardRangeAdder {

    private static final String CLASS_NAME = "StandardRange";
    private final AbstractStandardRangeActionAdder ownerAdder;

    private Double min;
    private Double max;

    StandardRangeAdderImpl(AbstractStandardRangeActionAdder ownerAdder) {
        this.ownerAdder = ownerAdder;
        this.min = Double.MIN_VALUE;
        this.max = Double.MAX_VALUE;
    }

    @Override
    public StandardRangeAdder withMin(double minSetpoint) {
        this.min = minSetpoint;
        return this;
    }

    @Override
    public StandardRangeAdder withMax(double maxSetpoint) {
        this.max = maxSetpoint;
        return this;
    }

    @Override
    public T add() {
        AdderUtils.assertAttributeNotNull(min, CLASS_NAME, "min value", "withMin()");
        AdderUtils.assertAttributeNotNull(max, CLASS_NAME, "max value", "withMax()");

        if (max == Double.MAX_VALUE) {
            throw new FaraoException("StandardRange max value was not defined.");
        }
        if (min == Double.MIN_VALUE) {
            throw new FaraoException("StandardRange min value was not defined.");
        }
        if (max < min) {
            throw new FaraoException("Max value of StandardRange must be equal or greater than min value.");
        }

        StandardRange standardRange = new StandardRangeImpl(min, max);

        ownerAdder.addRange(standardRange);
        return (T) ownerAdder;
    }
}