Struct libreda_db::chip::Circuit

pub struct Circuit<C = Coord, U = ()> where
    C: CoordinateType,
    U: Default,  { /* fields omitted */ }

A circuit is defined by an interface (pins) and a content which consists of interconnected circuit instances.

Template parameters:

• U: User defined data.

Implementations

impl Circuit

pub fn id(&self) -> CellId

Get the ID of this circuit.

pub fn name(&self) -> &String

Get the name of this circuit.

pub fn instance_id_by_name(&self, name: &str) -> Option<CellInstId>

Find a child instance in this circuit by its name.

pub fn each_instance_id(
    &self
) -> impl Iterator<Item = CellInstId> + '_ + ExactSizeIterator

Iterate over the IDs of the child instances.

pub fn each_dependency_id(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of each dependency of this circuit. A dependency is a circuit that is instantiated in self.

pub fn each_dependent_cell_id(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of cell that depends on this circuit.

pub fn each_parent(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of all cells that hold instances of this circuit.

pub fn each_reference(
    &self
) -> impl Iterator<Item = CellInstId> + '_ + ExactSizeIterator

Iterate over the IDs of all instances of this circuit.

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

Iterate over the IDs of the external circuit pins.

pub fn num_pins(&self) -> usize

Return the number of pins of this circuit.

pub fn pin_id_at(&self, position: usize) -> PinId

Get the ID of the pin at position.

pub fn each_net_id(
    &self
) -> impl Iterator<Item = NetId> + ExactSizeIterator + '_

Iterate over the IDs of all nets that are defined in this circuit.

pub fn shapes(&self, layer_id: &LayerId) -> Option<&Shapes<Coord>>

Get the shape container of this layer. Returns None if the shapes object does not exist for this layer.

Trait Implementations

impl<C: Clone, U: Clone> Clone for Circuit<C, U> where
    C: CoordinateType,
    U: Default, 

fn clone(&self) -> Circuit<C, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, U: Debug> Debug for Circuit<C, U> where
    C: CoordinateType,
    U: Default, 

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

Formats the value using the given formatter.