DotNet Reference

.Net Reference

Public Member Functions | Properties | List of all members
ReservoirConstraint

Detailed Description

Specialized reservoir constraint.

This constraint allows adding events (time, levelChange, isActive (optional)) to the reservoir constraint incrementally.

Definition at line 306 of file Constraints.cs.

Public Member Functions

 ReservoirConstraint (CpModel cp_model, CpModelProto model)
 
ReservoirConstraint AddEvent< T, L > (T time, L level_change)
 Adds a mandatory event. More...
 
ReservoirConstraint AddOptionalEvent< T, L > (T time, L level_change, ILiteral literal)
 Adds an optional event. More...
 
void OnlyEnforceIf (ILiteral lit)
 Adds a literal to the constraint. More...
 
void OnlyEnforceIf (ILiteral[] lits)
 Adds a list of literals to the constraint. More...
 

Properties

int Index [get]
 The index of the constraint in the model. More...
 
ConstraintProto Proto [get, set]
 The underlying constraint proto. More...
 

Constructor & Destructor Documentation

◆ ReservoirConstraint()

ReservoirConstraint ( CpModel  cp_model,
CpModelProto  model 
)
inline

Definition at line 308 of file Constraints.cs.

Member Function Documentation

◆ AddEvent< T, L >()

ReservoirConstraint AddEvent< T, L > ( T  time,
L  level_change 
)
inline

Adds a mandatory event.

It will increase the used capacity by level_change at time time. time must be an affine expression.

Definition at line 323 of file Constraints.cs.

◆ AddOptionalEvent< T, L >()

ReservoirConstraint AddOptionalEvent< T, L > ( T  time,
L  level_change,
ILiteral  literal 
)
inline

Adds an optional event.

If is_active is true, It will increase the used capacity by level_change at time time. time must be an affine expression.

Definition at line 342 of file Constraints.cs.

◆ OnlyEnforceIf() [1/2]

void OnlyEnforceIf ( ILiteral  lit)
inlineinherited

Adds a literal to the constraint.

Definition at line 38 of file Constraints.cs.

◆ OnlyEnforceIf() [2/2]

void OnlyEnforceIf ( ILiteral[]  lits)
inlineinherited

Adds a list of literals to the constraint.

Definition at line 44 of file Constraints.cs.

Property Documentation

◆ Index

int Index
getinherited

The index of the constraint in the model.

Definition at line 53 of file Constraints.cs.

◆ Proto

ConstraintProto Proto
getsetinherited

The underlying constraint proto.

Definition at line 61 of file Constraints.cs.

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