Struct libreda_db::reference_access::hierarchy_reference_access::CellRef

pub struct CellRef<'a, H: HierarchyBase + ?Sized> {
    pub(super) base: &'a H,
    pub(super) id: H::CellId,
}

A reference to a cell. This is just a wrapper around a netlist and a cell ID.

Fields

base: &'a H

Reference to the parent data structure.

id: H::CellId

ID of the corresponding cell.

Implementations

impl<'a, H: HierarchyBase> CellRef<'a, H>

pub fn base(&self) -> &H

Access the base structure.

pub fn id(&self) -> H::CellId

Get the ID of this cell.

pub fn name(&self) -> H::NameType

Get the name of the cell.

pub fn each_cell_instance_id(&self) -> impl Iterator<Item = H::CellInstId> + '_

Iterate over the IDs of all child instances.

pub fn each_cell_instance(
    &self
) -> impl Iterator<Item = CellInstRef<'a, H>> + '_

Iterate over all child instances.

pub fn cell_instance_by_name(&self, name: &str) -> Option<CellInstRef<'a, H>>

Find a child instance by its name.

pub fn each_reference_id(&self) -> impl Iterator<Item = H::CellInstId> + '_

Iterate over the IDs of all instances of this cell.

pub fn each_reference(&self) -> impl Iterator<Item = CellInstRef<'a, H>> + '_

Iterate over the of all instances of this cell.

pub fn num_references(&self) -> usize

Get the total number of usages of this cell.

pub fn each_cell_dependency(&self) -> impl Iterator<Item = CellRef<'a, H>> + '_

Iterate over all dependencies of this cell.

pub fn num_cell_dependencies(&self) -> usize

Get the total number of direct dependencies of this cell.

pub fn each_dependent_cell(&self) -> impl Iterator<Item = CellRef<'a, H>> + '_

Iterate over all cells that directly depend on this cell.

pub fn num_dependent_cells(&self) -> usize

Get the total number of cells which depend on this cell (i.e. use it).

pub fn num_child_instances(&self) -> usize

Get the number of cell instances inside the cell.

impl<'a, L: LayoutBase> CellRef<'a, L>

pub fn each_shape_per_layer(
    &self,
    layer_id: &L::LayerId
) -> impl Iterator<Item = ShapeRef<'_, L>> + '_

Iterate over all shapes on a layer.

pub fn each_shape(&self) -> impl Iterator<Item = ShapeRef<'_, L>> + '_

Iterate over all shapes defined in this cell.

pub fn bounding_box_per_layer(
    &self,
    layer_id: &L::LayerId
) -> Option<Rect<L::Coord>>

Get the bounding box of the shapes on a specific layer.

pub fn bounding_box(&self) -> Option<Rect<L::Coord>>

Get the bounding box of the shapes on all layers.

impl<'a, N: NetlistBase> CellRef<'a, N>

pub fn each_pin_id(&self) -> impl Iterator<Item = N::PinId> + '_

Iterate over the IDs of all pins of this cell.

pub fn each_pin(&self) -> impl Iterator<Item = PinRef<'a, N>> + '_

Iterate over all pins of this cell.

pub fn each_input_pin(&self) -> impl Iterator<Item = PinRef<'a, N>> + '_

Iterate over all input pins of this cell.

pub fn each_output_pin(&self) -> impl Iterator<Item = PinRef<'a, N>> + '_

Iterate over all output pins of this cell.

pub fn pin_by_name(&self, name: &str) -> Option<PinRef<'a, N>>

Find a pin by it’s name.

pub fn each_net(&self) -> impl Iterator<Item = NetRef<'a, N>> + '_

Iterate over all nets that live directly in this cell.

pub fn num_internal_nets(&self) -> usize

Get the number of nets inside this cell.

pub fn net_by_name(&self, name: &str) -> Option<NetRef<'a, N>>

Find a net by its name.

Trait Implementations

impl<'a, H: HierarchyBase> Clone for CellRef<'a, H>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.