rocon_remocon.interactions_table.InteractionsTable Class Reference

Classes. More...

List of all members.

Public Member Functions
def	__init__
def	__len__
def	__str__
def	append
def	clear
def	find
def	generate_role_view
def	roles
Public Attributes
	interactions
Static Private Attributes
list	__slots__

---

Detailed Description

Classes.

  The runtime populated interactions table along with methods to
  manipulate it.

  .. include:: weblinks.rst

Definition at line 32 of file interactions_table.py.

---

Constructor & Destructor Documentation

def rocon_remocon.interactions_table.InteractionsTable.__init__	(		self,
			filter_pairing_interactions = False
	)

Constructs an empty interactions table.

:param bool filter_pairing_interactions: do not load any paired interactions

Definition at line 43 of file interactions_table.py.

---

Member Function Documentation

def rocon_remocon.interactions_table.InteractionsTable.__len__

(

self

)

Definition at line 62 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.__str__

(

self

)

Convenient string representation of the table.

Definition at line 65 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.append	(		self,
			interaction
	)

Append an interaction to the table.

:param :class:`.Interaction` interaction:

Definition at line 100 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.clear	(		self,
			role_name
	)

Clear all interactions belonging to this role.

:param str role_name:

Definition at line 92 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.find	(		self,
			interaction_hash
	)

Find the specified interaction.

:param str interaction_hash: in crc32 format

:returns: interaction if found, None otherwise.
:rtype: :class:`.Interaction` or None

Definition at line 112 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.generate_role_view	(		self,
			role_name
	)

Creates a temporary copy of interactions filtered by the specified role
and sorts them into a dictionary view keyed by hash. This is a convenient
object for use by the interactions chooser.

:param str role_name: the filter for retrieving interactions

:returns: A role based view of the interactions
:rtype: dict { hash : :class:`.interactions.Interaction` }

Definition at line 74 of file interactions_table.py.

def rocon_remocon.interactions_table.InteractionsTable.roles

(

self

)

  List all roles for the currently stored interactions.

  :returns: a list of all roles
  :rtype: str[]

Definition at line 52 of file interactions_table.py.

---

Member Data Documentation

list rocon_remocon::interactions_table.InteractionsTable::__slots__ [static, private]

Initial value:

[
        'interactions',  # rocon_interactions.interactions.Interaction[]
    ]

Definition at line 39 of file interactions_table.py.

rocon_remocon::interactions_table.InteractionsTable::interactions

Definition at line 47 of file interactions_table.py.

---

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

• interactions_table.py