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 "../data_structure/ApplicationInstance.h"
29 #include "../parser/StatusManager.h"
30 #include <memory>
31 
32 namespace ScenarioManager::Exec
33 {
34  /**
35  * @class ApplicationStopper
36  * @ingroup exec
37  * @brief Interface for classes that handle how application get stopped and killed
38  */
40  {
41 
42  public:
43  /**
44  * Stops an application
45  * @param application application to be stopped
46  */
47  virtual void stop(Data_Structure::ApplicationInstancePtr application) = 0;
48 
49  /**
50  * Kills an application
51  * @param application application to be killed
52  */
53  virtual void kill(Data_Structure::ApplicationInstancePtr application) = 0;
54 
55  virtual void removeApplication(Data_Structure::ApplicationInstancePtr application, StatusManager statusManager) = 0;
56  virtual void removeScenario(Data_Structure::ScenarioPtr scenario, StatusManager statusManager) = 0;
57  };
58  using ApplicationStopperPtr = std::shared_ptr<ApplicationStopper>;
59 
60 }
ScenarioManager::Exec::ApplicationStopper::removeApplication
virtual void removeApplication(Data_Structure::ApplicationInstancePtr application, StatusManager statusManager)=0
ScenarioManager::Data_Structure::ApplicationInstancePtr
std::shared_ptr< ApplicationInstance > ApplicationInstancePtr
Definition: ApplicationInstance.h:33
ScenarioManager::Data_Structure::ScenarioPtr
std::shared_ptr< Scenario > ScenarioPtr
Definition: Scenario.h:36
ScenarioManager::Exec
Definition: ApplicationStarter.h:35
ScenarioManager::Exec::ApplicationStopperPtr
std::shared_ptr< ApplicationStopper > ApplicationStopperPtr
Definition: ApplicationStopper.h:58
ScenarioManager::Exec::ApplicationStopper::kill
virtual void kill(Data_Structure::ApplicationInstancePtr application)=0
Kills an application.
ScenarioManager::StatusManager
Definition: StatusManager.h:7
ScenarioManager::Exec::ApplicationStopper::removeScenario
virtual void removeScenario(Data_Structure::ScenarioPtr scenario, StatusManager statusManager)=0
ScenarioManager::Exec::ApplicationStopper
Interface for classes that handle how application get stopped and killed.
Definition: ApplicationStopper.h:39
ScenarioManager::Exec::ApplicationStopper::stop
virtual void stop(Data_Structure::ApplicationInstancePtr application)=0
Stops an application.