ConstraintBuilder Class Reference

#include <ConstraintBuilder.h>

Classes
class	ConstraintBuilderInvalidOperator

Public Member Functions
	ConstraintBuilder (ConstraintBuilderData &data)
ConstraintBuilder &	updateHourWithinWeek (unsigned hour)

variables_method
Documentation for non obvious methods Parameters index local index of the variable offset offset from the current time step delta number of time steps for the variable Returns reference of *this
ConstraintBuilderData &	data
ConstraintBuilder &	DispatchableProduction (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	NumberOfDispatchableUnits (unsigned int index, double coeff)
ConstraintBuilder &	NumberStoppingDispatchableUnits (unsigned int index, double coeff)
ConstraintBuilder &	NumberStartingDispatchableUnits (unsigned int index, double coeff)
ConstraintBuilder &	NumberBreakingDownDispatchableUnits (unsigned int index, double coeff)
ConstraintBuilder &	NTCDirect (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	IntercoDirectCost (unsigned int index, double coeff)
ConstraintBuilder &	IntercoIndirectCost (unsigned int index, double coeff)
ConstraintBuilder &	ShortTermStorageInjection (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	ShortTermStorageWithdrawal (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	ShortTermStorageLevel (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	ShortTermCostVariationInjection (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	ShortTermCostVariationWithdrawal (unsigned int index, double coeff, int offset=0, int delta=0)
ConstraintBuilder &	HydProd (unsigned int index, double coeff)
ConstraintBuilder &	HydProdDown (unsigned int index, double coeff)
ConstraintBuilder &	HydProdUp (unsigned int index, double coeff)
ConstraintBuilder &	Pumping (unsigned int index, double coeff)
ConstraintBuilder &	HydroLevel (unsigned int index, double coeff)
ConstraintBuilder &	Overflow (unsigned int index, double coeff)
ConstraintBuilder &	FinalStorage (unsigned int index, double coeff)
ConstraintBuilder &	PositiveUnsuppliedEnergy (unsigned int index, double coeff)
ConstraintBuilder &	NegativeUnsuppliedEnergy (unsigned int index, double coeff)
ConstraintBuilder &	LayerStorage (unsigned area, unsigned layer, double coeff)
ConstraintBuilder &	SetOperator (char op)
	set the operator of the constraint (sign)
ConstraintBuilder &	equalTo ()
	set the sign of the constraint to '=', building a constraint equal to rhs
ConstraintBuilder &	lessThan ()
	set the sign of the constraint to '<', building a constraint less than rhs
ConstraintBuilder &	greaterThan ()
	set the sign of the constraint to '>', building a constraint greather than rhs
void	build ()
	add the constraint in the matrix
int	NumberOfVariables () const

Detailed Description

this class build up the business object 'Constraint',
Math:
|coeff11 coeff12 .. coeff1n||var1| |sign_1|   |rhs1|       |constraint1||sign_1||rhs1|
|..      ..             ...||....| |......|   |....| <===> |...........||......||....|
|coeffn1 coeffn2 .. coeffnn||varn| |sign_n|   |rhsn|       |constraintn||sign_n||rhsn|

it propose a set of methods  to attach 'Variables' to the Constraint
ex: calling NTCDirect() implies adding Direct NTC Variable to the current Constraint
finally the build() method gather all variables and put them into the matrix

Member Function Documentation

build()

void ConstraintBuilder::build

(

)

add the constraint in the matrix

Returns

equalTo()

ConstraintBuilder & ConstraintBuilder::equalTo ( )

inline

set the sign of the constraint to '=', building a constraint equal to rhs

Returns

reference of *this

greaterThan()

ConstraintBuilder & ConstraintBuilder::greaterThan ( )

inline

set the sign of the constraint to '>', building a constraint greather than rhs

Returns

reference of *this

lessThan()

ConstraintBuilder & ConstraintBuilder::lessThan ( )

inline

set the sign of the constraint to '<', building a constraint less than rhs

Returns

reference of *this

SetOperator()

ConstraintBuilder & ConstraintBuilder::SetOperator ( char op )

inline

set the operator of the constraint (sign)

Parameters

op	the operator of the constraint

Returns

reference of *this

---

The documentation for this class was generated from the following files:

• src/solver/optimisation/include/antares/solver/optimisation/constraints/ConstraintBuilder.h
• src/solver/optimisation/constraints/ConstraintBuilder.cpp