Struct libreda_sta::models::clock_tag::ClockId

pub struct ClockId { /* private fields */ }

Compact ID for marking signals with a clock.

Identifier for clocks, generated clocks, propagated clocks, inverted clocks, etc. This struct is a wrapper around a 32-bit integer. It is used as an efficient marker to associate nets with a clock source.

Implementations

impl ClockId

pub fn new(storage_index: u32) -> Self

Create a new clock ID from the index of the clock. The index is a ‘pointer’ to the specification of the clock. The ID is used to annotate signals in order to link them to a clock source. The ID does not only store this index but also keeps track of other properties such as on which clock events the signal can change.

pub fn storage_index(&self) -> usize

Get the index into the array of clocks. Points to the detailed description of the corresponding clock.

pub fn is_inverted(&self) -> bool

Check if this ID refers to an inverted version of the clock.

pub fn is_clock(&self) -> bool

Test if this signal is marked as a clock signal. This flag gets cleared when a clock signal passes through a clock input of a sequential cell to a data output.

pub fn set_clock(&mut self, is_clock: bool)

Define if this signal is a clock or just a clocked signal otherwise.

pub fn inverted(&self) -> Self

Get the ID of the inverted clock.

pub fn is_sensitive_on_edge(&self, edge_type: RiseFall) -> bool

For actual signals: Test if the signal can change on the given edge type of the associated clock. For required signals: Test if the constraint applies to the given edge type of the associated clock.

pub fn set_edge_sensitivity(&mut self, edge_type: RiseFall, can_change: bool)

For actual signals: Define if the signal annotated with this ID can change on the given clock edge.

Trait Implementations

impl Clone for ClockId

fn clone(&self) -> ClockId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClockId

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

Formats the value using the given formatter.

impl Hash for ClockId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ClockId

fn cmp(&self, other: &ClockId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ClockId

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ClockId

fn partial_cmp(&self, other: &ClockId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ClockId

impl Eq for ClockId

impl StructuralPartialEq for ClockId