Public Member Functions | Public Attributes | Private Member Functions
lama_interfaces.core_interface.CoreDBInterface Class Reference
Inheritance diagram for lama_interfaces.core_interface.CoreDBInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def del_lama_object
def get_descriptor_links
def get_interface_info
def get_lama_object
def getter_callback
def interface_type
def set_lama_object
def setter_callback

Public Attributes

 core_table
 descriptor_table
 descriptor_table_name
 direct_attributes

Private Member Functions

def _check_md5sum
def _generate_core_table
def _generate_descriptor_table
def _generate_schema
def _insert_lama_object
def _lama_object_from_query_result
def _update_lama_object

Detailed Description

Definition at line 22 of file core_interface.py.


Constructor & Destructor Documentation

def lama_interfaces.core_interface.CoreDBInterface.__init__ (   self,
  interface_name = None,
  descriptor_table_name = None,
  start = False 
)
Build the map interface for LamaObject

Parameters
----------
- interface_name: string, name of the table containing LamaObject
    messages (vertices and edges). Defaults to 'lama_objects'.
- descriptor_table_name: string, name of the table for DescriptorLink
    messages. Defaults to 'lama_descriptor_links'.

Definition at line 23 of file core_interface.py.


Member Function Documentation

Check that current implementation is compatible with LamaObject

Definition at line 79 of file core_interface.py.

Create the SQL tables for LamaObject messages

Definition at line 93 of file core_interface.py.

Create the SQL tables for descriptor_links

Definition at line 111 of file core_interface.py.

Create the SQL tables

Definition at line 86 of file core_interface.py.

def lama_interfaces.core_interface.CoreDBInterface._insert_lama_object (   self,
  lama_object 
) [private]
Insert a new Lama Object into the core table without any checks

Do not invoke directly, use self.set_lama_object.

Definition at line 234 of file core_interface.py.

Definition at line 128 of file core_interface.py.

def lama_interfaces.core_interface.CoreDBInterface._update_lama_object (   self,
  lama_object 
) [private]
Update a Lama Object without any checks

Do not invoke directly, use self.set_lama_object.

Definition at line 259 of file core_interface.py.

Remove a LamaObject from the database

Definition at line 285 of file core_interface.py.

def lama_interfaces.core_interface.CoreDBInterface.get_descriptor_links (   self,
  id_,
  interface_name = None 
)
Retrieve the list of DescriptorLink associated with a Lama object

Return a list of DescriptorLink. If interface_name is given, return
all DescriptorLink corresponding to this interface_name, otherwise, and
if interface_name is '' or '*', return all DescriptorLink.

Parameters
----------
- id_: int, lama object id in the database.
- interface_name: string, default to None.
    If None, '', or '*', all DescriptorLink are returned.
    Otherwise, only DescriptorLink from this interface are returned.

Definition at line 294 of file core_interface.py.

Definition at line 329 of file core_interface.py.

Get a vertex or an edge from its unique id_

Return an instance of LamaObject.

Parameters
----------
- id_: int, lama object id (id in the database).

Definition at line 167 of file core_interface.py.

Get a LamaObject from the database

Get a LamaObject from the database, from its id.
Return an instance of GetLamaObject.srv response.

Parameters
----------
- msg: an instance of GetLamaObject.srv request.

Definition at line 136 of file core_interface.py.

Definition at line 76 of file core_interface.py.

Add/modify a lama object to the database

Return the lama object's id.

Parameter
---------
- lama_object: an instance of LamaObject.

Definition at line 190 of file core_interface.py.

Add a LamaObject message to the database

Return an instance of SetLamaObject.srv response.

Parameters
----------
- msg: an instance of SetLamaObject.srv request.

Definition at line 153 of file core_interface.py.


Member Data Documentation

Definition at line 93 of file core_interface.py.

Definition at line 111 of file core_interface.py.

Definition at line 31 of file core_interface.py.

Definition at line 31 of file core_interface.py.


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


interfaces
Author(s): Gaël Ecorchard , Karel Košnar
autogenerated on Sat Jun 8 2019 19:03:14