iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RunStateAction.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_MODEL_RUNSTATEACTION_H
37 #define INCLUDE_NRT_CORE_MODEL_RUNSTATEACTION_H
38 
39 #include <nrt/Core/Typing/Enum.H>
40 
41 namespace nrt
42 {
43  //! Helper enum to set the run state of a Component that is possibly on a remote Blackboard
44  /*! Note that normal users would typically rely on the started(), running(), etc member functions of Component as
45  those describe the current state. The RunStateAction enum describes state transitions, at a finer granularity than
46  is typically useful to normal users/programers. Mostly, this is used by the Blackboard system to bring the run
47  state up and down step-by-step over the whole Blackboard federation.
48 
49  \ingroup component */
50  NRT_DEFINE_ENUM_CLASS(RunStateAction, (PreInit) (Init) (PostInit) (PreStart) (Start) (PostStart) (InitiateLaunch)
51  (CompleteLaunch) (InitiateEndrun) (CompleteEndrun) (PreStop) (Stop) (PostStop) (PreUninit)
52  (Uninit) (PostUninit));
53 }
54 
55 #endif // INCLUDE_NRT_CORE_MODEL_RUNSTATEACTION_H