Public Member Functions | Public Attributes | Private Member Functions
lama_interfaces.local_map_agent.LocalMapAgent Class Reference

List of all members.

Public Member Functions

def __init__
def action_callback
def assign_descriptor_to_lama_object
def get_descriptor_links
def get_edge_list
def get_lama_object_list
def get_neighbor_vertices
def get_outgoing_edges
def get_vertex_list
def pull_lama_object
def push_lama_object

Public Attributes

 action_service_class
 action_service_name
 core_iface
 map_agent
 proxy

Private Member Functions

def _get_interface_info_callback

Detailed Description

Define callbacks for ActOnMap and possibly start the map agent service

The class directly accesses the database.

Definition at line 17 of file local_map_agent.py.


Constructor & Destructor Documentation

def lama_interfaces.local_map_agent.LocalMapAgent.__init__ (   self,
  start = False 
)

Definition at line 22 of file local_map_agent.py.


Member Function Documentation

Definition at line 132 of file local_map_agent.py.

Callback of ActOnMap service

Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 85 of file local_map_agent.py.

Add a descriptor to a vertex

Callback for ASSIGN_DESCRIPTOR_VERTEX and ASSIGN_DESCRIPTOR_EDGE.
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 177 of file local_map_agent.py.

Retrieve DescriptorLink associated with a LamaObject and an interface

Callback for GET_DESCRIPTOR_LINKS.
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 273 of file local_map_agent.py.

Retrieve edges from the database

Callback for GET_EDGE_LIST.
Retrieved all edges from the database that correspond to the search
criteria given in msg.object.
Search criteria are attributes with non-default values (0 or '').
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 255 of file local_map_agent.py.

Retrieve all elements that match the search criteria

Search criteria are attributes of lama_object with non-default values
(defaults are 0 or '').
Return a list of LamaObject, or an empty list of no LamaObject matches.

Parameters
----------
- lama_object: an instance of LamaObject

Definition at line 42 of file local_map_agent.py.

Retrieve all neighbor vertices from the database

Callback for GET_NEIGHBOR_VERTICES.
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 290 of file local_map_agent.py.

Retrieve edges starting at a given vertex

Callback for GET_OUTGOING_EDGES.
Return an instance of ActOnMap response containing edges (instances
of LamaObject) starting at the given vertex.
This is syntactic sugar because the functionality can be obtained with
GET_EDGE_LIST.

Parameters
----------
- msg: an instance of ActOnMapRequest.

Definition at line 305 of file local_map_agent.py.

Retrieve all vertices from the database

Callback for GET_VERTEX_LIST.
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 240 of file local_map_agent.py.

Retrieve a LaMa object from the database

Callback for PULL_VERTEX and PULL_EDGE.
The object id is given in msg.object.id.
Return an instance of ActOnMap response. The field descriptor_links will
be filled with all DescriptorLink associated with this LamaObject.
An error is raised if more LaMa objects correspond to the search
criteria.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 156 of file local_map_agent.py.

Add a LaMa object to the database

Callback for PUSH_VERTEX and PUSH_EDGE.
Return an instance of ActOnMap response.

Parameters
----------
- msg: an instance of ActOnMap request.

Definition at line 140 of file local_map_agent.py.


Member Data Documentation

Definition at line 22 of file local_map_agent.py.

Definition at line 22 of file local_map_agent.py.

Definition at line 22 of file local_map_agent.py.

Definition at line 22 of file local_map_agent.py.

Definition at line 22 of file local_map_agent.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