Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Data::BindingConstraintsRepository Class Referencefinal
Inheritance diagram for Antares::Data::BindingConstraintsRepository:

Public Types

using Vector = std::vector<std::shared_ptr<BindingConstraint>>
 Vector of binding constraints.
 
using Set = std::set<std::shared_ptr<BindingConstraint>, CompareBindingConstraintName>
 Ordered Set of binding constraints.
 
using iterator = Vector::iterator
 
using const_iterator = Vector::const_iterator
 

Public Member Functions

Constructor && Destructor
 BindingConstraintsRepository ()=default
 Default constructor.
 
 ~BindingConstraintsRepository ()=default
 Destructor.
 
void clear ()
 Delete all constraints.
 

Iterating through all constraints

template<class PredicateT >
void each (const PredicateT &predicate)
 Iterate through all constraints.
 
template<class PredicateT >
void each (const PredicateT &predicate) const
 Iterate through all constraints (const)
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
bool empty () const
 
std::shared_ptr< BindingConstraintadd (const AnyString &name)
 Add a new binding constraint.
 
std::shared_ptr< Data::BindingConstraintfind (const AnyString &id)
 
std::shared_ptr< const Data::BindingConstraintfind (const AnyString &id) const
 Try to find a constraint from its id (const)
 
Data::BindingConstraintfindByName (const AnyString &name)
 Try to find a constraint from its name.
 
const Data::BindingConstraintfindByName (const AnyString &name) const
 Try to find a constraint from its name (const)
 
bool loadFromFolder (Data::Study &s, const Data::StudyLoadOptions &options, const std::filesystem::path &folder)
 Load all binding constraints from a folder.
 
bool saveToFolder (const AnyString &folder) const
 Save all binding constraints into a folder.
 
void reverseWeightSign (const Data::AreaLink *lnk)
 Reverse the sign of the weight for a given interconnection or thermal cluster.
 
uint size () const
 Get the number of binding constraints.
 
void remove (const Data::BindingConstraint *bc)
 Remove a binding constraint.
 
void remove (const Data::Area *area)
 Remove any binding constraint linked with a given area.
 
void remove (const Data::AreaLink *area)
 Remove any binding constraint linked with a given interconnection.
 
void removeConstraintsWhoseNameConstains (const AnyString &filter)
 Remove any binding constraint whose name contains the string in argument.
 
bool rename (Data::BindingConstraint *bc, const AnyString &newname)
 Rename a binding constraint.
 
void changeConstraintsWeeklyToDaily ()
 Convert all weekly constraints into daily ones.
 
void forceReload (bool reload=false) const
 Invalidate all matrices of all binding constraints.
 
void markAsModified () const
 Mark the constraint as modified.
 
std::vector< std::shared_ptr< BindingConstraint > > activeConstraints () const
 
Vector getPtrForInequalityBindingConstraints () const
 
static std::vector< std::shared_ptr< BindingConstraint > > LoadBindingConstraint (EnvForLoading env)
 

Member Function Documentation

◆ find()

std::shared_ptr< Data::BindingConstraint > Antares::Data::BindingConstraintsRepository::find ( const AnyString & id)

Try to find a constraint from its id

◆ reverseWeightSign()

void Antares::Data::BindingConstraintsRepository::reverseWeightSign ( const Data::AreaLink * lnk)

Reverse the sign of the weight for a given interconnection or thermal cluster.

This method is used when reverting an interconnection or thermal cluster


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