Inheritance diagram for iron.placeable.Placeable:
Public Member Functions | |
| __init__ (self, PlacementTile|None tile) | |
| None | place (self, Tile tile) |
| PlacementTile|None | tile (self) |
Protected Attributes | |
| _tile | |
Private Attributes | |
| __class__ | |
Detailed Description
Placeable is a base class of an object that might be Placed by a Placer.
Constructor & Destructor Documentation
◆ __init__()
| iron.placeable.Placeable.__init__ | ( | self, | |
| PlacementTile | None | tile | ||
| ) |
Initialize a Placeable object.
Args:
tile (PlacementTile): A placeable object has a tile. This may be None during construction.
Reimplemented in iron.worker.Worker, iron.dataflow.objectfifo.ObjectFifoLink, iron.runtime.endpoint.RuntimeEndpoint, and iron.globalbuffer.GlobalBuffer.
Member Function Documentation
◆ place()
| None iron.placeable.Placeable.place | ( | self, | |
| Tile | tile | ||
| ) |
Place the object by assigning the object to a Tile.
Args:
tile (Tile): The placement tile.
Raises:
AlreadyPlacedError: If the object's tile is already set to a Tile object.
Reimplemented in iron.worker.Worker.
◆ tile()
| PlacementTile | None iron.placeable.Placeable.tile | ( | self | ) |
Return the tile of the placeable object.
Returns:
PlacementTile: The current placement of the object.
Member Data Documentation
◆ __class__
|
private |
◆ _tile
|
protected |
The documentation for this class was generated from the following file:
- iron/placeable.py
