createBindingConstraint {antaresEditObject} | R Documentation |
Create a Binding Constraint
createBindingConstraint(name, id = tolower(name), values = NULL, enabled = TRUE, timeStep = c("hourly", "daily", "weekly"), operator = c("both", "equal", "greater", "less"), coefficients = NULL, overwrite = FALSE, opts = antaresRead::simOptions())
name |
The name for the binding constraint |
id |
An id |
values |
Values used by the constraint. It contains one line per time step and three columns "less", "greater" and "equal". |
enabled |
Logical, is the constraint enabled ? |
timeStep |
Time step the constraint applies to : |
operator |
Type of constraint: equality, inequality on one side or both sides. |
coefficients |
A named vector containing the coefficients used by the constraint. |
overwrite |
If the constraint already exist, overwrite the previous value. |
opts |
List of simulation parameters returned by the function
|
An updated list containing various information about the simulation.
## Not run: createBindingConstraint( name = "myconstraint", values = matrix(data = rep(0, 8760 * 3), ncol = 3), enabled = FALSE, timeStep = "hourly", operator = "both", coefficients = c("fr%myarea" = 1) ) ## End(Not run)