Fraxinus  17.12-rc2
An IGT application
cxWorkflowState.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 
33 #ifndef CXWORKFLOWSTATE_H_
34 #define CXWORKFLOWSTATE_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include <iostream>
39 #include <QState>
40 #include <QStateMachine>
41 #include <QString>
42 #include <QAction>
43 #include "cxTypeConversions.h"
45 #include "boost/shared_ptr.hpp"
46 #include "cxForwardDeclarations.h"
47 
48 
49 namespace cx
50 {
51 
63 class cxResource_EXPORT WorkflowState: public QState
64 {
65 Q_OBJECT
66 
67 public:
68  WorkflowState(QState* parent, QString uid, QString name, CoreServicesPtr services, bool enableAction = true) :
69  QState(parent),
70  mUid(uid),
71  mName(name),
72  mAction(NULL),
73  mServices(services),
74  mEnableAction(enableAction)
75  {}
76 
77  virtual ~WorkflowState() {}
78 
79  virtual void onEntry(QEvent * event);
80  virtual void onExit(QEvent * event);
81 
82  virtual QString getUid() const { return mUid; }
83  virtual QString getName() const { return mName; }
84 
85  std::vector<WorkflowState*> getChildStates();
86  QAction* createAction(QActionGroup* group);
87 
88  virtual void enableAction(bool enable);
89 
90 signals:
91  void aboutToExit();
92 
93 public slots:
94  void canEnterSlot();
95 protected slots:
96  void setActionSlot();
97 
98 protected:
99  virtual bool canEnter() const = 0;
100  virtual QIcon getIcon() const = 0;
101  void autoStartHardware();
102 
103  QString mUid;
104  QString mName;
105  QAction* mAction;
107 
108 private:
109  bool mEnableAction;
110 };
111 
112 class cxResource_EXPORT ParentWorkflowState: public WorkflowState
113 {
114 Q_OBJECT
115 public:
116  ParentWorkflowState(QState* parent, CoreServicesPtr services) :
117  WorkflowState(parent, "ParentUid", "Parent", services) {}
118  virtual ~ParentWorkflowState() {}
119  virtual void onEntry(QEvent * event) {}
120  virtual void onExit(QEvent * event) {}
121  virtual bool canEnter() const { return true; }
122  virtual QIcon getIcon() const { return QIcon(""); }
123 };
124 
125 
129 }
130 #endif /* CXWORKFLOWSTATE_H_ */
virtual bool canEnter() const
virtual void onEntry(QEvent *event)
virtual QString getName() const
CoreServicesPtr mServices
virtual QString getUid() const
ParentWorkflowState(QState *parent, CoreServicesPtr services)
virtual void onExit(QEvent *event)
virtual QIcon getIcon() const
State in a WorkflowStateMachine.
boost::shared_ptr< class CoreServices > CoreServicesPtr
Definition: cxCameraStyle.h:59
WorkflowState(QState *parent, QString uid, QString name, CoreServicesPtr services, bool enableAction=true)
virtual ~WorkflowState()
Namespace for all CustusX production code.