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

Thermal. More...

#include <prepro.h>

Public Types

enum  {
  foDuration = 0 , poDuration , foRate , poRate ,
  npoMin , npoMax , preproAvailabilityMax
}
 

Constructor

Matrix data
 All {FO,PO}{Duration,Rate} annual values.
 
YString id
 
unsigned int unitCount
 
 PreproAvailability (const YString &id, unsigned int unitCount)
 Default constructor.
 
bool forceReload (bool reload) const
 
void markAsModified () const
 
void reset ()
 Reset all values to their default ones.
 
void copyFrom (const PreproAvailability &rhs)
 Copy data from another struct.
 
bool loadFromFolder (Study &study, const std::filesystem::path &folder)
 Load settings for the thermal prepro from a folder.
 
bool validate () const
 Validate most settings against min/max rules.
 
bool saveToFolder (const AnyString &folder) const
 Save settings used by the thermal prepro to a folder.
 
bool normalizeAndCheckNPO ()
 Normalize NPO max and check for consistency.
 

Detailed Description

Thermal.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
foDuration 

FO Duration (Forced outage Duration - Duree moyenne d'indisponibilite fortuite)

poDuration 

PO Duration (Planned outage Duration - Duree moyenne d'indisponibilite programmee)

foRate 

FO Rate (Forced outage Rate - Taux moyen d'indisponibilite fortuite)

poRate 

PO Rate (Planned outage Rate - Taux moyen d'indisponibilite programmee)

npoMin 

NPO min (nombre minimal de groupes en maintenance)

npoMax 

NPO max (nombre maximal de groupes en maintenance)

Member Function Documentation

◆ loadFromFolder()

bool Antares::Data::PreproAvailability::loadFromFolder ( Study & study,
const std::filesystem::path & folder )

Load settings for the thermal prepro from a folder.

Parameters
folderThe source folder
Returns
A non-zero value if the operation succeeded, 0 otherwise

◆ normalizeAndCheckNPO()

bool Antares::Data::PreproAvailability::normalizeAndCheckNPO ( )

Normalize NPO max and check for consistency.

This method should only be used by the solver

◆ saveToFolder()

bool Antares::Data::PreproAvailability::saveToFolder ( const AnyString & folder) const

Save settings used by the thermal prepro to a folder.

Parameters
folderThe targer folder
Returns
A non-zero value if the operation succeeded, 0 otherwise

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