InterTemporalRaoResult.java
/*
* Copyright (c) 2025, 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.powsybl.openrao.data.raoresult.api;
import com.powsybl.openrao.commons.PhysicalParameter;
import com.powsybl.openrao.data.crac.api.Instant;
import com.powsybl.openrao.data.crac.api.InstantKind;
import java.time.OffsetDateTime;
import java.util.List;
/**
* @author Thomas Bouquet {@literal <thomas.bouquet at rte-france.com>}
*/
public interface InterTemporalRaoResult extends RaoResult {
List<OffsetDateTime> getTimestamps();
default double getGlobalCost(InstantKind instantKind) {
return getGlobalFunctionalCost(instantKind) + getGlobalVirtualCost(instantKind);
}
double getGlobalFunctionalCost(InstantKind instantKind);
double getGlobalVirtualCost(InstantKind instantKind);
double getGlobalVirtualCost(InstantKind instantKind, String virtualCostName);
/**
* It gives the global cost of the situation at a given {@link Instant} according to the objective
* function defined in the RAO.
*
* @param optimizedInstant: The optimized instant to be studied (set to null to access initial results)
* @param timestamp: The timestamp to be studied
* @return The global cost of the situation state.
*/
default double getCost(Instant optimizedInstant, OffsetDateTime timestamp) {
return getFunctionalCost(optimizedInstant, timestamp) + getVirtualCost(optimizedInstant, timestamp);
}
/**
* It gives the functional cost of the situation at a given {@link Instant} according to the objective
* function defined in the RAO. It represents the main part of the objective function.
*
* @param optimizedInstant: The optimized instant to be studied (set to null to access initial results)
* @param timestamp: The timestamp to be studied
* @return The functional cost of the situation state.
*/
double getFunctionalCost(Instant optimizedInstant, OffsetDateTime timestamp);
/**
* It gives the sum of virtual costs of the situation at a given {@link Instant} according to the
* objective function defined in the RAO. It represents the secondary parts of the objective
* function.
*
* @param optimizedInstant: The optimized instant to be studied (set to null to access initial results)
* @param timestamp: The timestamp to be studied
* @return The global virtual cost of the situation state.
*/
double getVirtualCost(Instant optimizedInstant, OffsetDateTime timestamp);
/**
* It gives the specified virtual cost of the situation at a given {@link Instant}. It represents the
* secondary parts of the objective. If the specified name is not part of the virtual costs defined in the
* objective function, this method could return {@code Double.NaN} values.
*
* @param optimizedInstant: The optimized instant to be studied (set to null to access initial results)
* @param virtualCostName: The name of the virtual cost.
* @param timestamp: The timestamp to be studied
* @return The specific virtual cost of the situation state.
*/
double getVirtualCost(Instant optimizedInstant, String virtualCostName, OffsetDateTime timestamp);
/**
* Indicates whether the all the CNECs of a given type at a given instant of a given timestamp are secure.
*
* @param optimizedInstant: The instant to assess
* @param timestamp: The timestamp to assess
* @param u: The types of CNECs to check (FLOW -> FlowCNECs, ANGLE -> AngleCNECs, VOLTAGE -> VoltageCNECs). 1 to 3 arguments can be provided.
* @return whether all the CNECs of the given type(s) are secure at the optimized instant.
*/
boolean isSecure(Instant optimizedInstant, OffsetDateTime timestamp, PhysicalParameter... u);
boolean isSecure(OffsetDateTime timestamp, PhysicalParameter... u);
default boolean isSecure(OffsetDateTime timestamp) {
return isSecure(timestamp, PhysicalParameter.FLOW, PhysicalParameter.ANGLE, PhysicalParameter.VOLTAGE);
}
}