ApplicationStopper.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarXCore::core
19  * @author Nicola Miskowiec
20  * @date 2016
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 
25 
26 #pragma once
27 
28 #include <memory>
29 
30 #include "../data_structure/ApplicationInstance.h"
31 #include "../parser/StatusManager.h"
32 
33 namespace ScenarioManager::Exec
34 {
35  /**
36  * @class ApplicationStopper
37  * @ingroup exec
38  * @brief Interface for classes that handle how application get stopped and killed
39  */
41  {
42 
43  public:
44  /**
45  * Stops an application
46  * @param application application to be stopped
47  */
48  virtual void stop(Data_Structure::ApplicationInstancePtr application) = 0;
49 
50  /**
51  * Kills an application
52  * @param application application to be killed
53  */
54  virtual void kill(Data_Structure::ApplicationInstancePtr application) = 0;
55  };
56 
57  using ApplicationStopperPtr = std::shared_ptr<ApplicationStopper>;
58 
59 } // namespace ScenarioManager::Exec
ScenarioManager::Data_Structure::ApplicationInstancePtr
std::shared_ptr< ApplicationInstance > ApplicationInstancePtr
Definition: ApplicationInstance.h:33
ScenarioManager::Exec
Definition: ApplicationStarter.h:36
ScenarioManager::Exec::ApplicationStopperPtr
std::shared_ptr< ApplicationStopper > ApplicationStopperPtr
Definition: ApplicationStopper.h:57
ScenarioManager::Exec::ApplicationStopper::kill
virtual void kill(Data_Structure::ApplicationInstancePtr application)=0
Kills an application.
ScenarioManager::Exec::ApplicationStopper
Interface for classes that handle how application get stopped and killed.
Definition: ApplicationStopper.h:40
ScenarioManager::Exec::ApplicationStopper::stop
virtual void stop(Data_Structure::ApplicationInstancePtr application)=0
Stops an application.