lama_interfaces.cleartext_interface_factory.SqlMsg Class Reference

List of all members.

Public Member Functions
def	__init__
def	createAllTables
def	getter
def	setter
Public Attributes
	interface_name
	tables
	type
Private Member Functions
def	_createTable

---

Detailed Description

Interface between a ROS type and a database

Parameters
----------
- srv_name: str, name of the service to create table for.
- type_: str, ROS type associated with this service.

Definition at line 645 of file cleartext_interface_factory.py.

---

Constructor & Destructor Documentation

def lama_interfaces.cleartext_interface_factory.SqlMsg.__init__	(		self,
			interface_name,
			type_
	)

Definition at line 653 of file cleartext_interface_factory.py.

---

Member Function Documentation

def lama_interfaces.cleartext_interface_factory.SqlMsg._createTable	(		self,
			tablename,
			type_ = None,
			parenttable = None
	)		[private]

Generate the table description from message type

For arrays, two tables are actually created and this function is called
recursively to create a new table for the vector data.

Parameters:
    - tablename: str, table name, must be SQL compatible.
    - type_: str, type description.
    - parent: str, name of parent table for nested tables. A nested
table is created when an array is met in the ROS type.
Defaults to None, which is to be used only the first time
generateTable is called.

Definition at line 678 of file cleartext_interface_factory.py.

def lama_interfaces.cleartext_interface_factory.SqlMsg.createAllTables	(		self,
			metadata
	)

Add appropriate tables to represent a ROS message in the database

Definition at line 658 of file cleartext_interface_factory.py.

def lama_interfaces.cleartext_interface_factory.SqlMsg.getter	(		self,
			connection,
			id_
	)

Retrieve a message from the database

Parameters
----------
- connection: sqlalchemy engine connection instance.

Definition at line 721 of file cleartext_interface_factory.py.

def lama_interfaces.cleartext_interface_factory.SqlMsg.setter	(		self,
			connection,
			msg
	)

Add to the database and return the id

Parameters
----------
- connection: sqlalchemy engine connection instance.
- msg: instance of ROS message.

Definition at line 766 of file cleartext_interface_factory.py.

---

Member Data Documentation

lama_interfaces::cleartext_interface_factory.SqlMsg::interface_name

Definition at line 653 of file cleartext_interface_factory.py.

lama_interfaces::cleartext_interface_factory.SqlMsg::tables

Definition at line 653 of file cleartext_interface_factory.py.

lama_interfaces::cleartext_interface_factory.SqlMsg::type

Definition at line 653 of file cleartext_interface_factory.py.

---

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

• cleartext_interface_factory.py