com.farao_community.farao.data.crac_impl.OnStateAdderToRemedialActionImpl 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) 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/.
 */
package com.farao_community.farao.data.crac_impl;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.data.crac_api.Instant;
import com.farao_community.farao.data.crac_api.RemedialAction;
import com.farao_community.farao.data.crac_api.State;
import com.farao_community.farao.data.crac_api.usage_rule.OnContingencyStateAdderToRemedialAction;
import com.farao_community.farao.data.crac_api.usage_rule.UsageMethod;

import static com.farao_community.farao.data.crac_impl.AdderUtils.assertAttributeNotNull;

/**
 * Adds an OnContingencyState usage rule to a RemedialActionAdder
 * Needs the Contingency object and does not need the CRAC
 *
 * @author Peter Mitri {@literal }
 */
public class OnStateAdderToRemedialActionImpl> implements OnContingencyStateAdderToRemedialAction {

    private T owner;
    private UsageMethod usageMethod;
    private State state;
    private static final String CLASS_NAME = "OnContingencyState";

    OnStateAdderToRemedialActionImpl(RemedialAction owner) {
        this.owner = (T) owner;
    }

    @Override
    public OnContingencyStateAdderToRemedialAction withState(State state) {
        this.state = state;
        return this;
    }

    @Override
    public OnStateAdderToRemedialActionImpl withUsageMethod(UsageMethod usageMethod) {
        this.usageMethod = usageMethod;
        return this;
    }

    @Override
    public T add() {
        assertAttributeNotNull(state, CLASS_NAME, "state", "withState()");
        assertAttributeNotNull(usageMethod, CLASS_NAME, "usage method", "withUsageMethod()");
        if (state.isPreventive() && usageMethod != UsageMethod.FORCED) {
            throw new FaraoException("OnContingencyState usage rules are not allowed for PREVENTIVE instant except when FORCED. Please use newOnInstantUsageRule() instead.");
        } else if (state.getInstant().equals(Instant.OUTAGE)) {
            throw new FaraoException("OnContingencyState usage rules are not allowed for OUTAGE instant.");
        }
        owner.addUsageRule(new OnContingencyStateImpl(usageMethod, state));
        return owner;
    }
}