This function reads the binding constraints of an Antares project.
Be aware that binding constraints are read in the input files of a study. So they may have changed since a simulation has been run.
readBindingConstraints(opts = simOptions())
# S3 method for bindingConstraints
summary(object, ...)
list of simulation parameters returned by the function
setSimulationPath
Object returned by readBindingConstraints
Unused
readBindingConstraints
returns an object of class bindingConstraints
.
It is a named list with one element per read constraint. Each element is itself
a list with the following elements:
is the constraint enabled ?
time step the constraint applies to
type of constraint: equality, inequality on one side or both sides
elements containing the coefficients used by the constraint
values used by the constraint. It contains one line per time step and three columns "less", "greater" and "equal"
The summary
method returns a data.frame with one line per constraint.
if (FALSE) {
setSimulationPath()
constraints <- readBindingConstraints()
summary(constraints)
}