plugin.py
Go to the documentation of this file.
1 #!/usr/bin/env python
2 ################################################################################
3 #
4 # Copyright Airbus Group SAS 2015
5 # All rigths reserved.
6 #
7 # File Name : plugin.py
8 # Authors : Martin Matignon
9 #
10 # If you find any bug or if you have any question please contact
11 # Adolfo Suarez Roos <adolfo.suarez@airbus.com>
12 # Martin Matignon <martin.matignon.external@airbus.com>
13 #
14 #
15 ################################################################################
16 
17 ## @package: plugin
18 ##
19 ## @version 2.0
20 ## @author Matignon Martin
21 ## @date Last modified 19/08/2014
22 import rospy
23 
24 from plugin_installer import PluginInstaller
25 
26 """
27 Proposals for the version 2.1 :
28 
29  rename : control_mode_changed_event() by controlModeChangedEvent()
30  rename : user_changed_event() by userChangedEvent()
31  rename : emergency_stop_event() by emergencyStoppedEvent()
32  rename : retranslate_event() by retranslateEvent()
33 
34 """
35 
36 ## @class Plugin
37 ## @brief Base class for create a Python plugin.
38 class Plugin(PluginInstaller):
39 
40  def __init__(self):
41  PluginInstaller.__init__(self, self.userChangedEvent)
42 
43  def setup(self):
44  print self.__class__.__name__+"::setup()"
45 
46  def entry(self):
47  """! This methode called when user open this plugin.
48  - Start topic(s)
49  - Start thread(s)
50  - ...
51  """
52  print self.__class__.__name__+"::entry()"
53 
54 
55  def foregroundEvent(self):
56  print self.__class__.__name__+" Plaise change entry() by foregroundEvent() !"
57  self.entry()
58 
59  def exit(self):
60  """! This methode called when user open other plugin.
61  - Unregisters topic(s)
62  - Closes thread(s)
63  - ...
64  """
65  print self.__class__.__name__+"::exit()"
66 
67  def backgroundEvent(self):
68  print self.__class__.__name__+" Plaise change exit() by backgroundEvent() !"
69  self.exit()
70 
71  def control_mode_changed_event(self, control_mode):
72  """! Methode called when control mode changed.
73  @param control_mode: user informations.
74  @type control_mode: C{ControlMode}.
75  """
76  #Do some rules for the user privilege
77  pass
78 
79  def controlModeChangedEvent(self, mode):
80  """! Methode called when control mode changed.
81  @param control_mode: user informations.
82  @type control_mode: C{ControlMode}.
83  """
84  #Do some rules for the user privilege
85  print self.__class__.__name__+" Plaise change control_mode_changed_event() by controlModeChangedEvent() !"
86  self.control_mode_changed_event(mode)
87 
88  def user_changed_event(self, user):
89  """! Methode called when user account changed.
90  @param user: user informations.
91  @type user: C{User}.
92  """
93  #Do some rules for the user privilege
94  pass
95 
96  def userChangedEvent(self, user):
97  """! Methode called when control mode changed.
98  @param control_mode: user informations.
99  @type control_mode: C{ControlMode}.
100  """
101  #Do some rules for the user privilege
102  print self.__class__.__name__+" Plaise change user_changed_event() by userChangedEvent() !"
103  self.user_changed_event(user)
104 
105  def emergency_stop_event(self, status):
106  """! This methode called when emergency stop triggered.
107  """
108  pass
109 
110  def emergencyStoppedEvent(self, state):
111  """! This methode called when emergency stop triggered.
112  """
113  print self.__class__.__name__+" Plaise change emergency_stop_event() by emergencyStoppedEvent() !"
114  self.emergency_stop_event(state)
115 
116  def retranslate_event(self):
117  """! This methode called when language changed.
118  """
119  pass
120 
121  def retranslateEvent(self):
122  """! This methode called when language changed.
123  """
124  print self.__class__.__name__+" Plaise change retranslate_event() by retranslateEvent() !"
125  self.retranslate_event()
126 
127  def shutdown(self):
128  """! This methode called before airbus_cobot_gui closes.
129  - Unregisters topic(s)
130  - Closes thread(s)
131  - ...
132  """
133  pass
134 
135 #End of file
136 
def retranslate_event
This methode called when language changed.
Definition: plugin.py:116
def emergencyStoppedEvent
This methode called when emergency stop triggered.
Definition: plugin.py:110
def retranslateEvent
This methode called when language changed.
Definition: plugin.py:121
Base class for create a Python plugin.
Definition: plugin.py:38
def shutdown
This methode called before airbus_cobot_gui closes.
Definition: plugin.py:127
def exit
This methode called when user open other plugin.
Definition: plugin.py:59
def userChangedEvent
Methode called when control mode changed.
Definition: plugin.py:96
def entry
This methode called when user open this plugin.
Definition: plugin.py:46
def control_mode_changed_event
Methode called when control mode changed.
Definition: plugin.py:71
def controlModeChangedEvent
Methode called when control mode changed.
Definition: plugin.py:79
def emergency_stop_event
This methode called when emergency stop triggered.
Definition: plugin.py:105
def user_changed_event
Methode called when user account changed.
Definition: plugin.py:88


airbus_cobot_gui
Author(s):
autogenerated on Thu Dec 17 2015 11:42:05