Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
AdditionalConstraintsReader Struct Reference

candidate exclusion constraints reading structure More...

#include <AdditionalConstraintsReader.h>

Public Member Functions

 AdditionalConstraintsReader (ProblemGenerationLog::ProblemGenerationLoggerSharedPointer logger)
 
 AdditionalConstraintsReader (std::string const &constraints_file_path, ProblemGenerationLog::ProblemGenerationLoggerSharedPointer logger)
 AdditionalConstraintsReader from an inifile.
 
std::map< std::string, std::string > const & getVariablesSection ()
 return the section defining the binary variables to add
 
std::set< std::string > const & getSections () const
 returns the set of the names of sections defined in the file
 
std::map< std::string, std::string > const & getSection (std::string const &sectionName_p) const
 returns a section
 

Static Public Attributes

static std::string illegal_chars = " \n\r\t\f\v-+=:[]()"
 

Detailed Description

candidate exclusion constraints reading structure

Constructor & Destructor Documentation

◆ AdditionalConstraintsReader() [1/2]

AdditionalConstraintsReader::AdditionalConstraintsReader ( ProblemGenerationLog::ProblemGenerationLoggerSharedPointer  logger)
inline

default constructor for struct AdditionalConstraintsReader

◆ AdditionalConstraintsReader() [2/2]

AdditionalConstraintsReader::AdditionalConstraintsReader ( std::string const &  constraints_file_path,
ProblemGenerationLog::ProblemGenerationLoggerSharedPointer  logger 
)
explicit

AdditionalConstraintsReader from an inifile.

Parameters
constraints_file_pathString name of the file to use to read the additional constraints

Member Function Documentation

◆ getSection()

std::map< std::string, std::string > const & AdditionalConstraintsReader::getSection ( std::string const &  sectionName_p) const

returns a section

Parameters
sectionName_pString name of the section to return
Exceptions
ifthe section does not exist

◆ getSections()

std::set< std::string > const & AdditionalConstraintsReader::getSections ( ) const

returns the set of the names of sections defined in the file

Parameters
constraints_file_pathString name of the file to use to read the additional constraints

Member Data Documentation

◆ illegal_chars

std::string AdditionalConstraintsReader::illegal_chars = " \n\r\t\f\v-+=:[]()"
static

characters to forbid in variables and constraints names


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