pacman.model.routing_tables package

Module contents

class pacman.model.routing_tables.AbstractMulticastRoutingTable[source]

Bases: object

multicast_routing_entries

The multicast routing entries in the table

Returns:an iterable of multicast routing entries
Return type:iterable(spinn_machine.MulticastRoutingEntry)
Raises:None – does not raise any known exceptions
number_of_defaultable_entries

The number of multi-cast routing entries that are set to be defaultable within this multicast routing table

Returns:int
number_of_entries

The number of multi-cast routing entries there are in the multicast routing table

Returns:int
x

The x-coordinate of the chip of this table

Returns:The x-coordinate
Return type:int
y

The y-coordinate of the chip of this table

Returns:The y-coordinate
Return type:int
class pacman.model.routing_tables.CompressedMulticastRoutingTable(x, y, multicast_routing_entries=None)[source]

Bases: pacman.model.routing_tables.abstract_multicast_routing_table.AbstractMulticastRoutingTable

Represents a compressed routing table for a chip.

Parameters:
  • x (int) – The x-coordinate of the chip for which this is the routing table
  • y (int) – The y-coordinate of the chip for which this is the routing tables
  • multicast_routing_entries (iterable(MulticastRoutingEntry)) – The routing entries to add to the table
Raises:

pacman.exceptions.PacmanAlreadyExistsException – If any two routing entries contain the same key-mask combination
add_multicast_routing_entry(multicast_routing_entry)[source]

Adds a routing entry to this table

Parameters:multicast_routing_entry (MulticastRoutingEntry) – The route to add
Raises:pacman.exceptions.PacmanAlreadyExistsException – If a routing entry with the same key-mask combination already exists
multicast_routing_entries

The multicast routing entries in the table

Returns:an iterable of multicast routing entries
Return type:iterable(spinn_machine.MulticastRoutingEntry)
Raises:None – does not raise any known exceptions
number_of_defaultable_entries

The number of multi-cast routing entries that are set to be defaultable within this multicast routing table

Returns:int
number_of_entries

The number of multi-cast routing entries there are in the multicast routing table

Returns:int
x

The x-coordinate of the chip of this table

Returns:The x-coordinate
Return type:int
y

The y-coordinate of the chip of this table

Returns:The y-coordinate
Return type:int
class pacman.model.routing_tables.MulticastRoutingTables(routing_tables=None)[source]

Bases: object

Represents the multicast routing tables for a number of chips.

Parameters:routing_tables (iterable(MulticastRoutingTable)) – The routing tables to add
Raises:PacmanAlreadyExistsException – If any two routing tables are for the same chip
add_routing_table(routing_table)[source]

Add a routing table

Parameters:routing_table (MulticastRoutingTable) – a routing table to add
Return type:None
Raises:PacmanAlreadyExistsException – If a routing table already exists for the chip
get_routing_table_for_chip(x, y)[source]

Get a routing table for a particular chip

Parameters:
  • x (int) – The x-coordinate of the chip
  • y (int) – The y-coordinate of the chip
Returns:

The routing table, or None if no such table exists
Return type:

MulticastRoutingTable or None
Raises:

None – No known exceptions are raised
max_number_of_entries

The maximumn number of multi-cast routing entries there are in any multicast routing table

Will return zero if there are no routing tables

Return type:int
routing_tables

The routing tables stored within

Returns:an iterable of routing tables
Return type:iterable(MulticastRoutingTable)
Raises:None – does not raise any known exceptions
class pacman.model.routing_tables.UnCompressedMulticastRoutingTable(x, y, multicast_routing_entries=None)[source]

Bases: pacman.model.routing_tables.abstract_multicast_routing_table.AbstractMulticastRoutingTable

Represents a uncompressed routing table for a chip.

Parameters:
  • x (int) – The x-coordinate of the chip for which this is the routing table
  • y (int) – The y-coordinate of the chip for which this is the routing tables
  • multicast_routing_entries (iterable(MulticastRoutingEntry)) – The routing entries to add to the table
Raises:

PacmanAlreadyExistsException – If any two routing entries contain the same key-mask combination
add_multicast_routing_entry(multicast_routing_entry)[source]

Adds a routing entry to this table

Parameters:multicast_routing_entry (MulticastRoutingEntry) – The route to add
Return type:None
Raises:PacmanAlreadyExistsException – If a routing entry with the same key-mask combination already exists
get_entry_by_routing_entry_key(routing_entry_key)[source]

Get the routing entry associated with the specified key or None if the routing table does not match the key

Parameters:routing_entry_key (int) – the routing key to be searched
Returns:the routing entry associated with the routing key_combo or None if no such entry exists
Return type:MulticastRoutingEntry or None
get_multicast_routing_entry_by_routing_entry_key(routing_entry_key, mask)[source]

Get the routing entry associated with the specified key_combo-mask combination or None if the routing table does not match the key_combo

Parameters:
  • routing_entry_key (int) – the routing key to be searched
  • mask (int) – the routing mask to be searched
Returns:

the routing entry associated with the routing key_combo or None if no such entry exists
Return type:

MulticastRoutingEntry or None
multicast_routing_entries

The multicast routing entries in the table

Returns:

an iterable of multicast routing entries
Return type:

iterable(spinn_machine.MulticastRoutingEntry)
Raises:
  • None – does not raise any known exceptions The multicast routing entries in the table
  • None – does not raise any known exceptions
Return type:

iterable(MulticastRoutingEntry)
number_of_defaultable_entries

The number of multi-cast routing entries that are set to be defaultable within this multicast routing table

Returns:int The number of multicast routing entries that are set to be defaultable within this multicast routing table
Return type:int
number_of_entries

The number of multi-cast routing entries there are in the multicast routing table

Returns:int The number of multicast routing entries there are in the multicast routing table
Return type:int
x

The x-coordinate of the chip of this table

Returns:The x-coordinate
Return type:int The x-coordinate of the chip of this table
Return type:int
y

The y-coordinate of the chip of this table

Returns:The y-coordinate
Return type:int The y-coordinate of the chip of this table
Return type:int