← Back to branch summary

~ubuntu-branches/ubuntu/trusty/hugin/trusty-proposed

« back to all changes in this revision

Viewing changes to src/foreign/zthread/src/State.h

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2011-01-06 14:28:24 UTC
  • mfrom: (1.1.9 upstream) (0.1.21 experimental)
  • Revision ID: james.westby@ubuntu.com-20110106142824-zn9lxylg5z44dynn
* Drop Cyril Brulebois from Uploaders. Thank you very much for your work.
* Bump package version. (rc3 was re-released as 2010.4.0).

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/foreign/zthread/src/State.h
 
1
/*
 
2
 * Copyright (c) 2005, Eric Crahen
 
3
 *
 
4
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 
5
 * of this software and associated documentation files (the "Software"), to deal
 
6
 * in the Software without restriction, including without limitation the rights
 
7
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
8
 * copies of the Software, and to permit persons to whom the Software is furnished
 
9
 * to do so, subject to the following conditions:
 
10
 *
 
11
 * The above copyright notice and this permission notice shall be included in all
 
12
 * copies or substantial portions of the Software.
 
13
 *
 
14
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
15
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
16
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
17
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 
18
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 
19
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
20
 *
 
21
 */
 
22
 
 
23
#ifndef __ZTSTATE_H__
 
24
#define __ZTSTATE_H__
 
25
 
 
26
namespace ZThread {
 
27
 
 
28
/**
 
29
 * @class State 
 
30
 * @author Eric Crahen <http://www.code-foo.com>
 
31
 * @date <2003-07-16T20:04:01-0400>
 
32
 * @version 2.2.1
 
33
 *
 
34
 * Class to encapsulate the current state of the threads life-cycle.
 
35
 */
 
36
class State {
 
37
 public:
 
38
 
 
39
  //! Various states
 
40
  typedef enum { REFERENCE, IDLE, RUNNING, JOINED } STATE;
 
41
 
 
42
  /**
 
43
   * Create State with the given flag set.
 
44
   */
 
45
  State(STATE initialState) : _state(initialState) {}
 
46
 
 
47
  /**
 
48
   * Test for the IDLE state. No task has yet run.
 
49
   */
 
50
  bool isIdle() const {
 
51
    return _state == IDLE;
 
52
  }
 
53
 
 
54
  /**
 
55
   * Test for the JOINED state. A task has completed and 
 
56
   * the thread is join()ed.
 
57
   *
 
58
   * @return bool
 
59
   */
 
60
  bool isJoined() const {
 
61
    return _state == JOINED;
 
62
  }
 
63
 
 
64
  /**
 
65
   * Test for the RUNNING state. A task is in progress.
 
66
   *
 
67
   * @return bool
 
68
   */
 
69
  bool isRunning() const {
 
70
    return _state == RUNNING;
 
71
  }
 
72
 
 
73
  /**
 
74
   * Test for the REFERENCE state. A task is in progress but not
 
75
   * under control of this library.
 
76
   *
 
77
   * @return bool
 
78
   */
 
79
  bool isReference() const {
 
80
    return _state == REFERENCE;
 
81
  }
 
82
 
 
83
  /**
 
84
   * Transition to the IDLE state.
 
85
   *
 
86
   * @return bool true if successful
 
87
   */
 
88
  bool setIdle() {
 
89
 
 
90
    if(_state != RUNNING)
 
91
      return false;
 
92
 
 
93
    _state = IDLE;
 
94
    return true;
 
95
 
 
96
  }
 
97
 
 
98
  /**
 
99
   * Transition to the RUNNING state.
 
100
   *
 
101
   * @return bool true if successful
 
102
   */
 
103
  bool setRunning() {
 
104
 
 
105
    if(_state != IDLE)
 
106
      return false;
 
107
 
 
108
    _state = RUNNING;
 
109
    return true;
 
110
 
 
111
  }
 
112
 
 
113
  /**
 
114
   * Transition to the REFERENCE state.
 
115
   *
 
116
   * @return bool true if successful
 
117
   */
 
118
  bool setReference() {
 
119
 
 
120
    if(_state != IDLE)
 
121
      return false;
 
122
 
 
123
    _state = REFERENCE;
 
124
    return true;
 
125
 
 
126
  }
 
127
 
 
128
 
 
129
  /**
 
130
   * Transition to the JOINED state.
 
131
   *
 
132
   * @return bool true if successful
 
133
   */
 
134
  bool setJoined() {
 
135
 
 
136
    _state = JOINED;
 
137
    return true;
 
138
 
 
139
  }
 
140
 
 
141
 private:
 
142
 
 
143
  //! Current state
 
144
  STATE _state;
 
145
 
 
146
};
 
147
 
 
148
 
 
149
};
 
150
 
 
151
#endif