Struct substrate::layout::CellBuilder

pub struct CellBuilder<PDK: Pdk + ?Sized> {
    pub ctx: PdkContext<PDK>,
    /* private fields */
}

A layout cell builder.

Constructed once for each invocation of Layout::layout.

Fields

ctx: PdkContext<PDK>

The current global context.

Implementations

impl<PDK: Pdk> CellBuilder<PDK>

pub fn new(ctx: PdkContext<PDK>) -> Self

Creates a new layout builder.

pub fn generate<I: Layout<PDK>>(&mut self, block: I) -> Instance<I>

Generate an instance of block.

Returns immediately, allowing generation to complete in the background. Attempting to access the generated instance’s cell will block until generation is complete.

Examples

    impl Layout<ExamplePdk> for Buffer {
        fn layout(

            // ...

        ) -> substrate::error::Result<Self::LayoutData> {
            let inv1 = cell.generate(Inverter::new(self.strength));
            let inv2 = inv1.clone().align_bbox(AlignMode::ToTheRight, &inv1, 10);

            cell.draw(inv1.clone())?;
            cell.draw(inv2.clone())?;

            io.vdd.merge(inv1.io().vdd);
            io.vdd.merge(inv2.io().vdd);
            io.vss.merge(inv1.io().vss);
            io.vss.merge(inv2.io().vss);
            io.din.merge(inv1.io().din);
            io.dout.merge(inv2.io().dout);

            Ok(BufferData { inv1, inv2 })
        }
    }

pub fn generate_blocking<I: Layout<PDK>>( &mut self, block: I ) -> Result<Instance<I>>

Generate an instance of block.

Blocks on generation, returning only once the instance’s cell is populated. Useful for handling errors thrown by the generation of a cell immediately.

pub fn draw_blockage(&mut self, shape: Shape)

Draw a blockage.

pub fn draw(&mut self, obj: impl Draw<PDK>) -> Result<()>

Draw layout object obj.

For instances, a new thread is spawned to add the instance once the underlying cell has been generated. If generation fails, the spawned thread may panic after this function has been called.

For error recovery, instance generation results should be checked using Instance::try_cell before calling draw.

Panics

May cause a panic if generation of an underlying instance fails.

pub fn ctx(&self) -> &PdkContext<PDK>

Gets the global context.

Trait Implementations

impl<PDK: Pdk> Bbox for CellBuilder<PDK>

fn bbox(&self) -> Option<Rect>

Computes the axis-aligned rectangular bounding box.

fn bbox_rect(&self) -> Rect

Computes the axis-aligned rectangular bounding box, panicking if it is empty.

impl<PDK: Pdk> LayerBbox for CellBuilder<PDK>

fn layer_bbox(&self, layer: LayerId) -> Option<Rect>

Compute the bounding box considering only objects occupying the given layer.