Stop Class Reference

Simply stops the application, using the given ApplicationStopper. More...

#include <ArmarXCore/util/ScenarioManagerCommon/executor/Stop.h>

+ Inheritance diagram for Stop:

Public Member Functions

ApplicationStopperPtr getStopper ()
 Returns the stopper used by this StopStrategy.
 
 Stop (ApplicationStopperPtr stopper)
 Constructor that sets the ApplicationStopper used by this StopStrategy.
 
void stop (Data_Structure::ApplicationInstancePtr application) override
 Stops an application.
 
- Public Member Functions inherited from StopStrategy
 StopStrategy (ApplicationStopperPtr stopper)
 

Additional Inherited Members

- Protected Member Functions inherited from StopStrategy
void awaitTermination (const Data_Structure::ApplicationInstancePtr &application, int signalledPid)
 Waits until the process that was signalled has terminated, then clears the application's pid.
 
- Protected Attributes inherited from StopStrategy
ApplicationStopperPtr stopper
 
- Static Protected Attributes inherited from StopStrategy
static constexpr std::chrono::milliseconds TerminationTimeout {10000}
 How long to wait for a signalled process to actually disappear before giving up.
 

Detailed Description

Simply stops the application, using the given ApplicationStopper.

This StopStrategy can be made system-specific by switching out its ApplicationStopper.

Definition at line 39 of file Stop.h.

Constructor & Destructor Documentation

◆ Stop()

Constructor that sets the ApplicationStopper used by this StopStrategy.

Parameters
stopperstopper used in this strategy

Definition at line 32 of file Stop.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ getStopper()

ApplicationStopperPtr getStopper ( )

Returns the stopper used by this StopStrategy.

Returns
stopper used by this strategy

Definition at line 45 of file Stop.cpp.

◆ stop()

void stop ( Data_Structure::ApplicationInstancePtr application)
overridevirtual

Stops an application.

Parameters
applicationapplication to be stopped

Implements StopStrategy.

Definition at line 37 of file Stop.cpp.

+ Here is the call graph for this function:

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