Inheritance diagram for Antares::Data::BindingConstraint:

Public Types
enum	Type { typeUnknown = 0 , typeHourly , typeDaily , typeWeekly , typeMax }

enum	Operator { opUnknown = 0 , opEquality , opLess , opGreater , opBoth , opMax }

enum	Column { columnInferior = 0 , columnSuperior , columnEquality , columnMax }

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

using	linkWeightMap = std::map< const AreaLink *, double, CompareLinkName >
	Map of weight (for links)

using	iterator = linkWeightMap::iterator
	Iterator.

using	const_iterator = linkWeightMap::const_iterator
	Const iterator.

using	clusterWeightMap = std::map< const ThermalCluster *, double, CompareClusterName >
	Map of weight (for thermal clusters)

using	linkOffsetMap = std::map< const AreaLink *, int >
	Map of offset (for links)

using	clusterOffsetMap = std::map< const ThermalCluster *, int >
	Map of offset (for links)

Public Member Functions
Constructor & Destructor
	~BindingConstraint ()=default
	Destructor.

/ ID
const ConstraintName &	name () const
	Get the name of the binding constraint.

void	name (const AnyString &newname)
	Set the name of the binding constraint.

void	pId (const AnyString &name)
	Set the pId of the binding constraint.

const ConstraintName &	id () const
	Get the ID of the binding constraint.

Comments
const YString &	comments () const
	Get the comments.

Group
std::string	group () const
	Get the group.

void	group (std::string group_name)

void	comments (const AnyString &newcomments)
	Set the comments.

void	resetToDefaultValues ()

iterator
iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

bool	skipped () const

bool	isActive () const

const Matrix &	RHSTimeSeries () const

Matrix &	RHSTimeSeries ()

bool	hasAllWeightedLinksOnLayer (size_t layerID)

bool	hasAllWeightedClustersOnLayer (size_t layerID)

Links
double	weight (const AreaLink *lnk) const
	Get the weight of a given interconnection. More...

void	weight (const AreaLink *lnk, double w)
	Set the weight of an interconnection.

Thermal clusters
double	weight (const ThermalCluster *clstr) const
	Get the weight of a given thermal cluster. More...

void	weight (const ThermalCluster *clstr, double w)
	Set the weight of a thermal cluster.

void	removeAllWeights ()
	Remove all weights.

void	copyWeights (const Study &study, const BindingConstraint &rhs, bool emptyBefore, const std::function< void(AreaName &, const AreaName &)> &translate)
	Copy all weights from another constraint.

int	offset (const AreaLink *lnk) const
	Get the offset of a given interconnection. More...

int	offset (const ThermalCluster *lnk) const
	Get the offset of a given thermal cluster. More...

void	offset (const AreaLink *lnk, int o)
	Set the weight of an interconnection.

void	offset (const ThermalCluster *clstr, int o)
	Set the weight of a thermal cluster.

void	copyOffsets (const Study &study, const BindingConstraint &rhs, bool emptyBefore, const std::function< void(AreaName &, const AreaName &)> &translate)
	Copy all offsets from another constraint.

uint	linkCount () const
	Get how many links the binding constraint contains.

uint	clusterCount () const
	Get how many thermal clusters the binding constraint contains.

Type of the binding constraint
Type	type () const
	Get the type of the binding constraint.

void	setTimeGranularity (Type t)
	Set the type of the binding constraint.

Operator
Operator	operatorType () const

void	operatorType (Operator o)

uint	yearByYearFilter () const

uint	synthesisFilter () const

Enabled / Disabled
bool	enabled () const
	Get if the binding constraint is enabled.

void	enabled (bool v)
	Enabled / Disabled the binding constraint.

Static Public Member Functions
static const char *	TypeToCString (Type t)
	Convert a binding constraint type into a mere C-String.

static Type	StringToType (const AnyString &text)
	Convert a string into its corresponding type.

static const char *	OperatorToCString (Operator o)
	Convert a binding constraint operator into a mere C-String.

static const char *	OperatorToShortCString (Operator o)
	Convert a binding constraint operator into a short C-String.

static const char *	MathOperatorToCString (Operator o)
	Convert a binding constraint operator into a short C-String (symbol)

static Operator	StringToOperator (const AnyString &text)
	Converter a raw string into an operator.

Friends
class	BindingConstraintLoader

class	BindingConstraintSaver

Reset
void	clearAndReset (const AnyString &name, Type newType, Operator op)
	Clear all values and reset the binding constraint to its new type. More...

bool	forceReload (bool reload=false) const
	Invalidate all matrices.

void	markAsModified () const
	Mark the constraint as modified.

void	reverseWeightSign (const AreaLink *lnk)
	Reverse the sign of the weight for a given interconnection or thermal cluster. More...

bool	contains (const BindingConstraint *bc) const
	Get if the given binding constraint is identical.

bool	contains (const Area *area) const
	Get if the binding constraint is linked with a given area.

bool	contains (const AreaLink *lnk) const
	Get if the binding constraint is linked with an interconnection or thermal cluster.

bool	contains (const ThermalCluster *clstr) const

void	buildFormula (YString &s) const
	Build a human readable formula for the binding constraint.

BindingConstraintStructures	initLinkArrays () const

template<class Env >
std::string	timeSeriesFileName (const Env &env) const

const clusterWeightMap &	clustersAndWeights () const

Member Enumeration Documentation

◆ Column

enum Antares::Data::BindingConstraint::Column

Enumerator
columnMax	The maximum number of columns which can be found in the value matrix.

◆ Type

enum Antares::Data::BindingConstraint::Type

Enumerator
typeUnknown	Unknown status.
typeHourly	The binding constraint has hourly values.
typeDaily	The binding constraint has daily values.
typeWeekly	The binding constraint has weekly values.
typeMax	The maximum number of types.

Member Function Documentation

◆ clearAndReset()

void Antares::Data::BindingConstraint::clearAndReset	(	const AnyString &	name,
		BindingConstraint::Type	newType,
		BindingConstraint::Operator	op
	)

Clear all values and reset the binding constraint to its new type.

Parameters

name	Name of the binding constraint
newType	Its new type (hourly, daily...)

◆ offset() [1/2]

int Antares::Data::BindingConstraint::offset ( const AreaLink * lnk ) const

Get the offset of a given interconnection.

Returns: The offset of the interconnection. 0. if not found

◆ offset() [2/2]

int Antares::Data::BindingConstraint::offset ( const ThermalCluster * lnk ) const

Get the offset of a given thermal cluster.

Returns: The offset of the cluster. 0. if not found

◆ reverseWeightSign()

void Antares::Data::BindingConstraint::reverseWeightSign ( const 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

◆ weight() [1/2]

double Antares::Data::BindingConstraint::weight ( const AreaLink * lnk ) const

Get the weight of a given interconnection.

Returns: The weight of the interconnection. 0. if not found

◆ weight() [2/2]

double Antares::Data::BindingConstraint::weight ( const ThermalCluster * clstr ) const

Get the weight of a given thermal cluster.

Returns: The weight of the thermal cluster. 0. if not found

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

src/libs/antares/study/include/antares/study/binding_constraint/BindingConstraint.h
src/libs/antares/study/binding_constraint/BindingConstraint.cpp
src/libs/antares/study/include/antares/study/binding_constraint/BindingConstraint.hxx

Public Types

Public Member Functions

Static Public Member Functions

Friends

Reset