src/OSspecific/OSspecific/sigQuit.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::sigQuit
  26
  27 Description
  28     Signal handler for QUIT interupt.
  29
  30     The standard interupt handler is overridden to ensure that the
  31     runningJob file is removed.
  32
  33 See Also
  34     Foam::JobInfo
  35
  36 SourceFiles
  37     sigQuit.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef sigQuit_H
  42 #define sigQuit_H
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class sigQuit Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 //- Forward declaration of the OS specific implementation
  54 class sigQuitImpl;
  55
  56 class sigQuit
  57 {
  58     // Private data
  59
  60         //- The actual implementation (opaque pointer): PIMPL
  61         sigQuitImpl* impl_;
  62
  63 public:
  64
  65     // Constructors
  66
  67         sigQuit();
  68
  69
  70     // Destructor
  71
  72         ~sigQuit();
  73
  74
  75     // Member functions
  76
  77         void set(const bool verbose);
  78 };
  79
  80
  81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  82
  83 } // End namespace Foam
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 #endif
  88
  89 // ************************ vim: set sw=4 sts=4 et: ************************ //