StudyUpdateLinkParameterStrategy Class Reference

Inheritance diagram for StudyUpdateLinkParameterStrategy:

Public Member Functions
	StudyUpdateLinkParameterStrategy (const std::filesystem::path &link_path, ProblemGenerationLog::ProblemGenerationLoggerSharedPointer logger)
int	Update (const ActiveLink &link, const std::map< std::string, double > &map) override
std::filesystem::path	getLinkdataFilepath (const ActiveLink &link_p) const
	returns the path to the linkdata file related to a link
std::pair< double, double >	computeNewCapacities (const std::map< std::string, double > &investments_p, const ActiveLink &link_p, int timepoint_p) const
	computes the new capacities of related to a link
Public Member Functions inherited from StudyUpdateStrategy
	StudyUpdateStrategy (const std::filesystem::path &study_path, ProblemGenerationLog::ProblemGenerationLoggerSharedPointer logger)

Additional Inherited Members
Protected Member Functions inherited from StudyUpdateStrategy
void	EnsureCandidateInvestmentFound (const std::map< std::string, double > &investments_p, const ActiveLink &link_p, const Candidate &candidate, const std::map< std::string, double >::const_iterator &it_candidate) const
Protected Attributes inherited from StudyUpdateStrategy
const std::filesystem::path	antares_link_folder_path
ProblemGenerationLog::ProblemGenerationLoggerSharedPointer	logger_

Member Function Documentation

computeNewCapacities()

std::pair< double, double > StudyUpdateLinkParameterStrategy::computeNewCapacities	(	const std::map< std::string, double > &	investments_p,
		const ActiveLink &	link_p,
		int	timepoint_p
	)		const

computes the new capacities of related to a link

Parameters

investment_p	: investment to consider for the candidates of the link
link_p	: link for which the capacities will be computed
timepoint_p	: timepoint where the capcities will be computed

Returns

a pair of the computed direct and indirect capacities

getLinkdataFilepath()

std::filesystem::path StudyUpdateLinkParameterStrategy::getLinkdataFilepath

(

const ActiveLink &

link_p

)

const

returns the path to the linkdata file related to a link

Parameters

link_p

: link for which the datalink file path will be returned

Update()

int StudyUpdateLinkParameterStrategy::Update ( const ActiveLink &  link, const std::map< std::string, double > &  map  )

overridevirtual

Implements StudyUpdateStrategy.

---

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

• src/cpp/study-updater/include/StudyUpdateLinkParameterStrategy.h
• src/cpp/study-updater/StudyUpdateLinkParameterStrategy.cpp