Antares::Toolbox::Process::JobExecute Class Reference

Dedicated class to customize the job. More...

Inheritance diagram for Antares::Toolbox::Process::JobExecute:

Public Member Functions
	JobExecute (const wxString &command, const wxString &workingdirectory, const wxString &title, const wxString &subTitle, const char *icon)
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 ()
	Execute the real task.
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	disable ()
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.
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 ()

Friends
class	JobProcess

Detailed Description

Dedicated class to customize the job.

Member Function Documentation

executeTask()

bool Antares::Toolbox::Process::JobExecute::executeTask ( )

protectedvirtual

Execute the real task.

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

onBeforeRunning()

void Antares::Toolbox::Process::JobExecute::onBeforeRunning ( )

protectedvirtual

Event: Before the thread is launched.

This method will be fired before the thread is launched when the job is asked to run.

See also

run()

Reimplemented from Antares::Toolbox::Jobs::Job.

onCancel()

void Antares::Toolbox::Process::JobExecute::onCancel ( )

protectedvirtual

Event: The user ask to cancel the operation.

Reimplemented from Antares::Toolbox::Jobs::Job.

onRunQuery()

bool Antares::Toolbox::Process::JobExecute::onRunQuery ( )

protectedvirtual

Event: Ask if the job is allow to run.

This method is fired before running the job. It is actually thefirst check done by the method run()

See also

run()

Reimplemented from Antares::Toolbox::Jobs::Job.

---

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

• src/ui/simulator/toolbox/execute/execute.cpp