Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
execute.h
1
/*
2
** Copyright 2007-2024, RTE (https://www.rte-france.com)
3
** See AUTHORS.txt
4
** SPDX-License-Identifier: MPL-2.0
5
** This file is part of Antares-Simulator,
6
** Adequacy and Performance assessment for interconnected energy networks.
7
**
8
** Antares_Simulator is free software: you can redistribute it and/or modify
9
** it under the terms of the Mozilla Public Licence 2.0 as published by
10
** the Mozilla Foundation, either version 2 of the License, or
11
** (at your option) any later version.
12
**
13
** Antares_Simulator is distributed in the hope that it will be useful,
14
** but WITHOUT ANY WARRANTY; without even the implied warranty of
15
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
** Mozilla Public Licence 2.0 for more details.
17
**
18
** You should have received a copy of the Mozilla Public Licence 2.0
19
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20
*/
21
#ifndef __ANTARES_TOOLBOX_E_EXECUTE_H__
22
#define __ANTARES_TOOLBOX_E_EXECUTE_H__
23
24
#include <wx/wx.h>
25
26
namespace
Antares
27
{
28
namespace
Toolbox
29
{
30
namespace
Process
31
{
32
class
Execute
33
{
34
public
:
36
39
Execute
();
43
~Execute
();
45
47
48
49
const
wxString&
command
()
const
50
{
51
return
pCommand;
52
}
54
void
command
(
const
wxString& v)
55
{
56
pCommand = v;
57
}
59
61
62
63
const
wxString&
workingDirectory
()
const
64
{
65
return
pWDirectory;
66
}
68
void
workingDirectory
(
const
wxString& v)
69
{
70
pWDirectory = v;
71
}
73
75
76
77
const
wxString&
title
()
const
78
{
79
return
pTitle;
80
}
82
void
title
(
const
wxString& v)
83
{
84
pTitle = v;
85
}
87
89
90
91
const
wxString&
subTitle
()
const
92
{
93
return
pSubTitle;
94
}
96
void
subTitle
(
const
wxString& v)
97
{
98
pSubTitle = v;
99
}
101
103
104
105
bool
displayProgressBar
()
const
106
{
107
return
pDisplayProgressBar;
108
}
110
void
displayProgressBar
(
const
bool
v)
111
{
112
pDisplayProgressBar = v;
113
}
115
117
118
119
const
char
*
icon
()
const
120
{
121
return
pIcon;
122
}
124
void
icon
(
const
char
* v)
125
{
126
pIcon = v;
127
}
129
131
132
135
bool
run
();
137
138
private
:
140
wxString pTitle;
142
wxString pSubTitle;
144
wxString pCommand;
146
wxString pWDirectory;
148
bool
pDisplayProgressBar;
150
const
char
* pIcon;
151
152
};
// class Execute
153
154
}
// namespace Process
155
}
// namespace Toolbox
156
}
// namespace Antares
157
158
#endif
// __ANTARES_TOOLBOX_E_EXECUTE_H__
Antares::Toolbox::Process::Execute
Definition
execute.h:33
Antares::Toolbox::Process::Execute::title
void title(const wxString &v)
Set the title.
Definition
execute.h:82
Antares::Toolbox::Process::Execute::workingDirectory
const wxString & workingDirectory() const
Get the working directory to use before executing the command.
Definition
execute.h:63
Antares::Toolbox::Process::Execute::displayProgressBar
void displayProgressBar(const bool v)
Set if the progress bar can be displayed.
Definition
execute.h:110
Antares::Toolbox::Process::Execute::subTitle
const wxString & subTitle() const
Get the sub-title value.
Definition
execute.h:91
Antares::Toolbox::Process::Execute::icon
void icon(const char *v)
Set the relative address to the icon in the resources folder.
Definition
execute.h:124
Antares::Toolbox::Process::Execute::~Execute
~Execute()
Destructor.
Definition
execute.cpp:255
Antares::Toolbox::Process::Execute::Execute
Execute()
Default constructor.
Definition
execute.cpp:246
Antares::Toolbox::Process::Execute::command
void command(const wxString &v)
Set the command to execute.
Definition
execute.h:54
Antares::Toolbox::Process::Execute::subTitle
void subTitle(const wxString &v)
Set the sub-title.
Definition
execute.h:96
Antares::Toolbox::Process::Execute::run
bool run()
Run the command.
Definition
execute.cpp:259
Antares::Toolbox::Process::Execute::displayProgressBar
bool displayProgressBar() const
Get if the progress bar can be displayed.
Definition
execute.h:105
Antares::Toolbox::Process::Execute::command
const wxString & command() const
Get the command.
Definition
execute.h:49
Antares::Toolbox::Process::Execute::icon
const char * icon() const
Get the relative address to the icon in the resources folder.
Definition
execute.h:119
Antares::Toolbox::Process::Execute::workingDirectory
void workingDirectory(const wxString &v)
Set the working directory.
Definition
execute.h:68
Antares::Toolbox::Process::Execute::title
const wxString & title() const
Get the sub-title value.
Definition
execute.h:77
src
ui
simulator
toolbox
execute
execute.h
Generated by
1.12.0