editBindingConstraint {antaresEditObject} | R Documentation |
Update an existing binding constraint
Description
Update an existing binding constraint in an Antares study.
Usage
editBindingConstraint(
name,
id = tolower(name),
values = NULL,
enabled = NULL,
timeStep = NULL,
operator = NULL,
filter_year_by_year = NULL,
filter_synthesis = NULL,
coefficients = NULL,
opts = antaresRead::simOptions()
)
Arguments
name |
The name for the binding constraint. |
id |
An id, default is to use the name. |
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. |
filter_year_by_year |
Marginal price granularity for year by year |
filter_synthesis |
Marginal price granularity for synthesis |
coefficients |
A named vector containing the coefficients used by the constraint. |
opts |
List of simulation parameters returned by the function
|
Value
An updated list containing various information about the simulation.
See Also
createBindingConstraint()
to create new binding constraints, removeBindingConstraint()
to remove binding constraints.
Examples
## Not run:
editBindingConstraint(
name = "myconstraint",
values = matrix(data = rep(0, 8760 * 3), ncol = 3),
enabled = FALSE,
timeStep = "hourly",
operator = "both",
coefficients = c("fr%de" = 1)
)
## End(Not run)