StopperFactory.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 "ApplicationStopper.h"
29 #include <IceGrid/Admin.h>
30 #include <memory>
31 
32 namespace ScenarioManager::Exec
33 {
34  /**
35  * @class StopperFactory
36  * @ingroup exec
37  * @brief Abstract base class for factory classes that create ApplicationStopper.
38  * Should be implemented for each operating system.
39  */
41  {
42 
43  public:
44  /**
45  * Returns a system-specific ApplicationStopper, which stops by using the pid.
46  * @return system-specific by pid stopper
47  */
49 
50  /**
51  * Returns a system-specific ApplicationStopper, which stops by using the name.
52  * @return system-specific by name stopper
53  */
55 
56  /**
57  * Returns an IceStopper. Should be indipendent from the operating system.
58  * @return system-indipendent IceStopper
59  */
60  ApplicationStopperPtr getIceStopper(const IceGrid::AdminPrx admin);
61 
62  /**
63  * Returns the right StopperFactory for this operating system.
64  * @return StopperFactory depending on the operating system
65  */
66  static std::shared_ptr<StopperFactory> getFactory();
67  };
68  using StopperFactoryPtr = std::shared_ptr<ScenarioManager::Exec::StopperFactory>;
69 }
ScenarioManager::Exec
Definition: ApplicationStarter.h:35
ScenarioManager::Exec::ApplicationStopperPtr
std::shared_ptr< ApplicationStopper > ApplicationStopperPtr
Definition: ApplicationStopper.h:58
ScenarioManager::Exec::StopperFactoryPtr
std::shared_ptr< ScenarioManager::Exec::StopperFactory > StopperFactoryPtr
Definition: StopperFactory.h:68
ScenarioManager::Exec::StopperFactory::getIceStopper
ApplicationStopperPtr getIceStopper(const IceGrid::AdminPrx admin)
Returns an IceStopper.
Definition: StopperFactory.cpp:33
ScenarioManager::Exec::StopperFactory::getPidStopper
virtual ApplicationStopperPtr getPidStopper()=0
Returns a system-specific ApplicationStopper, which stops by using the pid.
ScenarioManager::Exec::StopperFactory::getByNameStopper
virtual ApplicationStopperPtr getByNameStopper()=0
Returns a system-specific ApplicationStopper, which stops by using the name.
ApplicationStopper.h
ScenarioManager::Exec::StopperFactory
Abstract base class for factory classes that create ApplicationStopper. Should be implemented for eac...
Definition: StopperFactory.h:40
ScenarioManager::Exec::StopperFactory::getFactory
static std::shared_ptr< StopperFactory > getFactory()
Returns the right StopperFactory for this operating system.
Definition: StopperFactory.cpp:38