TimeoutExample.h
Go to the documentation of this file.
1 /*
2 * This file is part of ArmarX.
3 *
4 * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5 *
6 * ArmarX is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * ArmarX is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 * @package ArmarXCore::StatechartExamples::TimeoutExample
19 * @author Mirko Waechter (mirko.waechter at kit dot edu)
20 * @date 2012
21 * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22 * GNU General Public License
23 */
24 
25 #pragma once
26 
30 
31 namespace armarx
32 {
34  {
35  public:
37 
38  // inherited from Component
39  std::string
40  getDefaultName() const override
41  {
42  return "TimeoutExample";
43  };
44 
45  void onInitStatechart() override;
46  void onConnectStatechart() override;
47  void run();
48  };
49  struct stateInstallTimeout;
50  DEFINEEVENT(Next)
51  DEFINEEVENT(TimerExpired)
52 
54  {
55  void
56  defineState() override
57  {
58  // setStateName("StatechartTimeoutexample");
59  }
60 
61  void
62  defineSubstates() override
63  {
64  //add substates
65  setInitState(addState<stateInstallTimeout>("InstallTimeout"));
66 
67  StateBasePtr finalSuccess = addState<SuccessState>("Success");
68  StateBasePtr finalFailure = addState<FailureState>("Failure");
69 
70  // add transition
71  addTransition<Next>(getInitState(), getInitState());
72  addTransition<TimerExpired>(getInitState(), finalFailure);
73  addTransition<Success>(getInitState(), finalSuccess);
74  }
75  };
76 
77 
78  struct DelayState;
79 
80  struct stateInstallTimeout : StateTemplate<stateInstallTimeout>
81  {
82 
83 
84  void
85  onEnter() override
86  {
87 
88  setTimeoutEvent(5000, createEvent<TimerExpired>());
89  }
90 
91  void
92  onExit() override
93  {
94  }
95  };
96 
97 
98 } // namespace armarx
armarx::StateTemplate
Definition: State.h:38
armarx::stateInstallTimeout::onExit
void onExit() override
Definition: TimeoutExample.h:92
armarx::TimeoutExample
Definition: TimeoutExample.h:33
armarx::TimeoutExampleStatechart::defineState
void defineState() override
Definition: TimeoutExample.h:56
armarx::TimeoutExample::statechart
StatePtr statechart
Definition: TimeoutExample.h:36
armarx::stateInstallTimeout
Definition: TimeoutExample.h:80
Statechart.h
IceInternal::Handle< State >
ARMARXCOMPONENT_IMPORT_EXPORT
#define ARMARXCOMPONENT_IMPORT_EXPORT
Definition: ImportExportComponent.h:38
armarx::StatechartContext
This class contains a statechart and provides the interfaces to distributed components.
Definition: StatechartContext.h:85
Component.h
armarx::TimeoutExampleStatechart
Definition: TimeoutExample.h:53
armarx::TimeoutExample::getDefaultName
std::string getDefaultName() const override
Retrieve default name of component.
Definition: TimeoutExample.h:40
armarx::DEFINEEVENT
DEFINEEVENT(EvInit) struct StateRun
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::TimeoutExampleStatechart::defineSubstates
void defineSubstates() override
Definition: TimeoutExample.h:62
armarx::stateInstallTimeout::onEnter
void onEnter() override
Definition: TimeoutExample.h:85
ImportExportComponent.h