Struct libreda_db::layout::cell::Cell

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

A Cell is a container for geometrical shapes organized on different layers. Additionally to the geometrical shapes a cell can also contain instances of other cells.

Implementations

impl<C: CoordinateType> Cell<C>

pub fn index(&self) -> CellIndex

Get index of this cell.

pub fn name(&self) -> Option<String>

Return the cell name if it is defined.

pub fn clear_shapes(&self)

Remove all shapes from this cell.

pub fn clear_instances(&self)

Remove all instances from this cell.

pub fn clear(&self)

Remove all shapes and instances from this cell.

pub fn clear_layer(&self, layer_index: LayerIndex)

Remove all shapes from the given layer.

pub fn create_instance(
    &self,
    template_cell: &Rc<Cell<C>>,
    transform: SimpleTransform<C>
) -> Rc<CellInstance<C>>

Insert a child cell instance.

pub fn num_references(&self) -> usize

Get the number of cell instances that reference this cell.

pub fn remove_cell_instance(&self, cell_instance: &Rc<CellInstance<C>>)

Remove the given cell instance from this cell.

Panics

Panics if the cell instance does not live in this cell. TODO: Return an Err and let the user decide how to handle the error.

pub fn self_reference(&self) -> Weak<Self>

Get reference to this cell.

pub fn shapes(&self, layer_index: LayerIndex) -> Option<Rc<Shapes<C>>>

Get the shapes object for the given layer.

pub fn shapes_get_or_create(&self, layer_index: LayerIndex) -> Rc<Shapes<C>>

Get the mutable shapes object for the given layer or create a new one when no exists for this index.

pub fn each_used_layer(&self) -> Vec<LayerIndex>

Return a Vec of all layers that contain at least one shape.

pub fn each_shape(
    &self,
    layer_index: LayerIndex
) -> impl Iterator<Item = Rc<Shape<C>>> + '_

Returns an iterator over all shapes of a given layer.

pub fn each_inst(&self) -> impl Iterator<Item = Rc<CellInstance<C>>> + '_

Returns an iterator over all child instances. (Returns reference to resource counted pointer).

pub fn is_leaf(&self) -> bool

Returns true if this cell does not contain any other cell instances.

Trait Implementations

impl<C: Clone + CoordinateType> Clone for Cell<C>

fn clone(&self) -> Cell<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<C: CoordinateType> Eq for Cell<C>

impl<C: CoordinateType> Hash for Cell<C>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<C: CoordinateType> PartialEq<Cell<C>> for Cell<C>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<C: CoordinateType> TryBoundingBox<C> for Cell<C>

fn try_bounding_box(&self) -> Option<Rect<C>>

Return the bounding box of this geometry if a bounding box is defined.

impl<C: CoordinateType> WithProperties for Cell<C>

type Key = String

Property key type.

fn with_properties<F, R>(&self, f: F) -> R where
    F: FnOnce(Option<&PropertyStore<Self::Key>>) -> R, 

Call a function with maybe the property storage as argument.

fn with_properties_mut<F, R>(&self, f: F) -> R where
    F: FnOnce(&mut PropertyStore<Self::Key>) -> R, 

Get mutable reference to the property storage.

fn property<Q: ?Sized>(&self, key: &Q) -> Option<PropertyValue> where
    Self::Key: Borrow<Q>,
    Q: Eq + Hash, 

Get a property value by the property key.

fn property_str<Q: ?Sized>(&self, key: &Q) -> Option<Rc<String>> where
    Self::Key: Borrow<Q>,
    Q: Eq + Hash, 

Get a string property value by key. If the property value is not a string None is returned.

fn set_property<V: Into<PropertyValue>>(
    &self,
    key: Self::Key,
    value: V
) -> Option<PropertyValue>

Insert a property. Returns the old property value if there was already a property stored under this key.