Blame view

src/jobtimer.h 3.34 KB
19eefb3c   Steven de Ridder   Initial commit. d...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
  /* ****************************************************************************
   * Copyright 2019 Open Systems Development BV                                 *
   *                                                                            *
   * Permission is hereby granted, free of charge, to any person obtaining a    *
   * copy of this software and associated documentation files (the "Software"), *
   * to deal in the Software without restriction, including without limitation  *
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
   * and/or sell copies of the Software, and to permit persons to whom the      *
   * Software is furnished to do so, subject to the following conditions:       *
   *                                                                            *
   * The above copyright notice and this permission notice shall be included in *
   * all copies or substantial portions of the Software.                        *
   *                                                                            *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
   * DEALINGS IN THE SOFTWARE.                                                  *
   * ***************************************************************************/
  
  #ifndef OSDEV_COMPONENTS_JOBTIMER_H
  #define OSDEV_COMPONENTS_JOBTIMER_H
  
  #include <QTimer>
  #include <QObject>
  #include <QDateTime>
  #include <QHash>
  #include <QString>
  #include <QVariant>
  #include <QSharedPointer>
  
  #include "jobdata.h"
  
  namespace osdev {
  namespace components {
  
  /*  ______________________________________
   * / Got a dictionary? I want to know the \
   * \ meaning of life.                     /
   *  --------------------------------------
   *   \
   *    \
   *        .--.
   *       |o_o |
   *       |:_/ |
   *      //   \ \
   *     (|     | )
   *    /'\_   _/`\
   *    \___)=(___/
   *//*!
   * \brief   Instead of using separate timers, The job *is* the timer.
   */
  class JobTimer : public QTimer
  {
      Q_OBJECT
  public:
      /*!
       * \brief   C'tor taking a jobdata structure to initialize the jobTimer.
       */
      JobTimer( const JobData& _jobData, QObject *_parent = nullptr );
  
      /*!
       * \brief   D'tor
       */
      virtual ~JobTimer();
  
      /*!
       * \brief   Get the jobData as a structure from the scheduled object.
       * \return  The data as object. Empty if no data was set.
       */
       JobData jobData() const { return m_jobData; }
  
  private:
      /*!
       * \brief   Connect all internal signals and slots.
       */
      void connectSignalsSlots();
  
      JobData m_jobData;          ///< Structure to hold all jobInformation.
  
  signals:
      /*!
       * \brief   Send the requested job by its name to all connected libraries.
       */
      void signalRunJob( const QString& jobName );
  
  private slots:
      /*!
       * \brief   Will be called by the parent object (QTimer) times out.
       */
      void slotTimeOut();
  
  };
  
  }   /* End namespace components */
  }   /* End namespace osdev      */
  
  #endif  /* OSDEV_COMPONENTS_JOBTIMER_H */