Struct libreda_db::layout::hashmap_layout::Layout

pub struct Layout<C: CoordinateType> { /* fields omitted */ }

Data structure which holds cells and cell instances.

Examples

use libreda_db::prelude::*;
let layout = Layout::new();

Trait Implementations

impl<C: Debug + CoordinateType> Debug for Layout<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: Default + CoordinateType> Default for Layout<C>

fn default() -> Layout<C>

Returns the "default value" for a type.

impl<C: CoordinateType> LayoutBase for Layout<C>

type Coord = C

Number type used for coordinates.

type NameType = RcString

Type for names of circuits, instances, pins, etc.

type LayerId = LayerId

Layer identifier type.

type CellId = CellId<C>

Cell/module identifier type.

type CellInstId = CellInstId<C>

Cell instance identifier type.

fn new() -> Self

Create a new empty netlist.

fn cell_by_name<N: ?Sized + Eq + Hash>(&self, name: &N) -> Option<Self::CellId> where
    Self::NameType: Borrow<N>, 

Find a cell by its name. Return the cell with the given name. Returns None if the cell does not exist.

fn each_cell(&self) -> Box<dyn Iterator<Item = Self::CellId>>

Iterate over all cells.

fn each_cell_instance(
    &self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellInstId>>

Iterate over all child instance in a cell.

fn each_dependent_cell(
    &self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellId>>

Iterate over all cells that contain a child of type cell.

fn each_cell_dependency(
    &self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellId>>

Iterate over all cells types that are instantiated in this cell.

fn parent_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the parent cell of this instance.

fn template_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the template cell of this instance.

fn find_layer(&self, index: u32, datatype: u32) -> Option<Self::LayerId>

Find layer index by the (index, data type) tuple.

impl<C: CoordinateType> LayoutEdit for Layout<C>

fn find_or_create_layer(&mut self, index: u32, datatype: u32) -> LayerId

Create a layer or return an existing one.

fn create_cell(&mut self, name: RcString) -> CellId<C>

Create a new and empty cell.

fn remove_cell(&mut self, cell_id: &CellId<C>)

Delete the given cell if it exists.

fn create_cell_instance(
    &mut self,
    parent_cell: &CellId<C>,
    template_cell: &CellId<C>,
    name: Option<RcString>,
    transform: SimpleTransform<C>
) -> CellInstId<C>

Create a new instance of template_cell in parent_cell.

fn remove_cell_instance(&mut self, id: &CellInstId<C>)

Remove cell instance if it exists.