Loading [MathJax]/extensions/tex2jax.js
Antares Simulator
Power System Simulator
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Modules Pages Concepts
Antares::Data::AreaLink Class Referencefinal

Definition of a link between two areas (Interconnection) More...

#include <links.h>

Inheritance diagram for Antares::Data::AreaLink:

Public Types

using Vector = std::vector<AreaLink*>
 Vector of links.
 
using Set = std::set<AreaLink*, CompareLinkName>
 Set of links.
 
using Map = std::map<AreaName, AreaLink*>
 Map of links.
 
using NamePair = std::pair<Yuni::String, Yuni::String>
 

Public Member Functions

Constructor & Destructor
 AreaLink ()
 Default Constructor.
 
 ~AreaLink ()
 Destructor.
 
bool loadTimeSeries (const StudyVersion &version, const std::filesystem::path &folder)
 
void storeTimeseriesNumbers (Solver::IResultWriter &writer) const
 
Area
void detach ()
 Detach the link from the areas.
 

Public Attributes

Graph
Areafrom
 The orginal Area.
 
Areawith
 The other area | Hash ID: with->id.
 
TimeSeriesNumbers timeseriesNumbers
 Monte-Carlo.
 
Data
Matrix parameters
 Data related to the link.
 
TimeSeries directCapacities
 
TimeSeries indirectCapacities
 
bool useLoopFlow
 Flag for using loop flow.
 
bool usePST
 Flag for using the phase shifter.
 
bool useHurdlesCost
 Flag for using hurdles cost.
 
LocalTransmissionCapacities transmissionCapacities
 Flag for the transmission capacities (NTC +infinite)
 
AssetType assetType
 Flag for the asset type (AC/DC/Other)
 
Indexes
uint index
 Index of the link in the entire list if Interconnections.
 
uint indexForArea
 Index of the link in the list of interconnection of the main area.
 
Comments
Yuni::String comments
 Comments.
 
bool displayComments
 Flag for displaying comments.
 

Output filtering

uint filterSynthesis
 Print results for the area in the simulation synthesis.
 
uint filterYearByYear
 Print results for the area in the year-by-year mode.
 
int color [3]
 Colors.
 
StyleType style
 Style.
 
int linkWidth
 link width
 
struct CompareLinkName
 

Data management

void reverse ()
 Reverse the link.
 
void resetToDefaultValues ()
 
bool forceReload (bool reload=false) const
 Invalidate all matrices.
 
void markAsModified () const
 Mark the data associated to the link as modified.
 
bool isVisibleOnLayer (const size_t &layerID) const
 
Yuni::String getName () const
 
bool isLinkPhysical () const
 
void overrideTransmissionCapacityAccordingToGlobalParameter (GlobalTransmissionCapacities tc)
 

Detailed Description

Definition of a link between two areas (Interconnection)

Member Function Documentation

◆ forceReload()

bool Antares::Data::AreaLink::forceReload ( bool reload = false) const

Invalidate all matrices.

Parameters
reloadTrue to load all missing data

◆ reverse()

void Antares::Data::AreaLink::reverse ( )

Reverse the link.

Be careful, this method does not invert the sign of the weight for binding constraints.


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