antaresRead (version 2.7.0)

readBindingConstraints: Read binding constraints

Description

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.

Usage

readBindingConstraints(opts = simOptions())

Value

An object of class bindingConstraints. This object is also a named list with 3 sections per read constraint.

Arguments

opts

list of simulation parameters returned by the function setSimulationPath

Warning

Since release 2.7.0 the structure of the returned object has evolved for all versions of study Antares:

• .ini parameters are in section properties

• Coeffcients links or thermal are in section coefs

• Values are already in section values

Examples

if (FALSE) {
setSimulationPath()

constraints <- readBindingConstraints()

# read properties
constraints$properties

# read coefs
constraints$coefs

# read values
constraints$values
  # both case ( study Antares >=8.7.0)
constraints$values$less
constraints$values$greater

# display equation (only for study Antares <8.7.0)
summary(constraints)

}