Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Solver::Progression Class Referencefinal

Progress meter about any operation performed on the attached study. More...

#include <progression.h>

Classes

class  Task
 

Public Types

enum  Section {
  sectYear = 0 , sectOutput , sectTSGLoad , sectTSGSolar ,
  sectTSGWind , sectTSGHydro , sectTSGThermal , sectImportTS ,
  sectMax
}
 
enum  { npos = (uint)-1 }
 

Public Member Functions

const char * SectionToCStr (Section section)
 
Default constructor
 ~Progression ()
 Destructor.
 
void add (uint year, Section section, unsigned nbTicks)
 Declare a new part of the progression.
 
void add (Section section, int nbTicks)
 
bool saveToFile (const Yuni::String &filename, IResultWriter &writer)
 
void setNumberOfParallelYears (uint nb)
 

Thread management

class Task
 
void start ()
 Start the thread dedicated to the progress notification.
 
void stop ()
 Stop the thread dedicated to the progress notification.
 
Part & begin (uint year, Section section)
 
void end (Part &part)
 

Detailed Description

Progress meter about any operation performed on the attached study.

Member Function Documentation

◆ add()

void Antares::Solver::Progression::add ( uint year,
Section section,
unsigned nbTicks )

Declare a new part of the progression.

Parameters
yearThe associated year
sectionThe section in this year
nbTicksThe total number of ticks to achieve

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