Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Forms::JobLoadScenarioBuilder Class Referencefinal
Inheritance diagram for Antares::Forms::JobLoadScenarioBuilder:
Antares::Toolbox::Jobs::Job

Public Member Functions

 JobLoadScenarioBuilder (Data::Study &study)
 
virtual ~JobLoadScenarioBuilder ()
 Destructor.
 
Data::ScenarioBuilder::SetsscenarioBuilder () const
 Sets.
 
- Public Member Functions inherited from Antares::Toolbox::Jobs::Job
 Job (const wxString &title, const wxString &subTitle, const char *icon)
 Constructor.
 
virtual ~Job ()
 Destructor.
 
bool displayProgression () const
 
void displayProgression (const bool v)
 
bool canCancel () const
 
void canCancel (const bool v)
 
bool result () const
 
void result (const bool v)
 
bool isRunning () const
 Get if the job is running.
 
bool run ()
 Run the job.
 
void stop ()
 Stop the job gracefully.
 

Protected Member Functions

virtual bool executeTask () override
 Load a study from a folder.
 
- Protected Member Functions inherited from Antares::Toolbox::Jobs::Job
void updateTheProgressValue (double progress)
 Update the progress value.
 
void updateTheMessage (const wxString &msg, bool mustBeInterpreted=true)
 Update the message displayed for the user.
 
virtual void onBeforeRunning ()
 Event: Before the thread is launched.
 
virtual bool onRunQuery ()
 Event: Ask if the job is allow to run.
 
virtual void onCancel ()
 Event: The user ask to cancel the operation.
 
void stopAllGuiComponents ()
 Gracefully Stop all Gui components.
 
void manageLogLevelMessage (enum LogLevel lvl, const wxString &msg)
 Dispatch a log entry, grabbed from from the standard output.
 
void onCancel (void *)
 Event: The user asks to cancel the operation.
 
void evtOnClose (wxCloseEvent &evt)
 
void onLogMessage (int, const std::string &message)
 
wxSizer * createMainPnl (wxWindow *parent)
 Create the main panel, which contains all important controls.
 
wxSizer * createPnlButtons (wxWindow *parent)
 Create the bottom panel, which contains buttons to cancel and to continue.
 
wxSizer * createPnlLoading (wxWindow *parent)
 
void displayGauge (const bool visible=true)
 Display (or not) the gauge.
 
void displayMessage (const wxString &line)
 
void onUIUpdateProgression (uint value)
 
void onUIUpdateMessage ()
 
void onUIUpdateLabelErrors ()
 
void onUIUpdateElapsedTime (const Yuni::String &text)
 
void onUIUpdateRemainingTime (const Yuni::String &text)
 
void evtOnInit (wxInitDialogEvent &event)
 
void deleteAllThreads ()
 
void recomputeWindowSize ()
 
void disableAllComponents ()
 

Member Function Documentation

◆ executeTask()

virtual bool Antares::Forms::JobLoadScenarioBuilder::executeTask ( )
inlineoverrideprotectedvirtual

Load a study from a folder.

Implements Antares::Toolbox::Jobs::Job.


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