KeyBinding.KeyBinding Class Reference

List of all members.

Public Member Functions
def	__init__
def	get_info
def	get_key
def	get_message
def	get_subscribed_topic
def	publish_message
Public Attributes
	info
	key
	message
	subscribed_topic

---

Detailed Description

This is the data structure that supports key binding information. It holds a relation between a button,
a message, and a topic. This key will eventually be used to send the desired message to the corresponding topic.

Definition at line 8 of file KeyBinding.py.

---

Constructor & Destructor Documentation

def KeyBinding.KeyBinding.__init__	(		self,
			key,
			message,
			subscribed_topic,
			info
	)

:param key: A keyboard button.
:param message: A ROS message ready to be published.
:param subscribed_topic: A ROS topic open for message publication.
This is the basic constructor method for the KeyBinding class.

Definition at line 14 of file KeyBinding.py.

---

Member Function Documentation

def KeyBinding.KeyBinding.get_info

(

self

)

:return:

Definition at line 25 of file KeyBinding.py.

def KeyBinding.KeyBinding.get_key

(

self

)

:return self._key: A string representing the key to this binding.
This method allows public access to the key of the present binding.

Definition at line 32 of file KeyBinding.py.

def KeyBinding.KeyBinding.get_message

(

self

)

:return self._message: A string representing the bound message.
This method allows public access to the message content.

Definition at line 39 of file KeyBinding.py.

def KeyBinding.KeyBinding.get_subscribed_topic

(

self

)

:return self._subscribed_topic: A string representing the bound subscribed topic.
This method allows public access to the subscribed topic.

Definition at line 46 of file KeyBinding.py.

def KeyBinding.KeyBinding.publish_message

(

self

)

:return None:
This method publishes the bound message to the subscribed topic.

Definition at line 53 of file KeyBinding.py.

---

Member Data Documentation

KeyBinding.KeyBinding::info

Definition at line 19 of file KeyBinding.py.

KeyBinding.KeyBinding::key

Definition at line 19 of file KeyBinding.py.

KeyBinding.KeyBinding::message

Definition at line 19 of file KeyBinding.py.

KeyBinding.KeyBinding::subscribed_topic

Definition at line 19 of file KeyBinding.py.

---

The documentation for this class was generated from the following file:

• KeyBinding.py