Skip to main content

SimulationState

Struct SimulationState 

Source
pub struct SimulationState<B: SimBackend> { /* private fields */ }
Expand description

Backend-independent state and execution rules for timed simulation.

Implementations§

Source§

impl<B: SimBackend> SimulationState<B>

Source

pub fn synchronize_event_values(&mut self, backend: &B)

Rebase edge detection after state was advanced outside this scheduler.

Source

pub fn new( backend: &B, topo_signals: Vec<(SignalRef, usize, usize)>, domain_kinds: Vec<Option<DomainKind>>, event_info: Vec<EventInfo<B>>, processes: Vec<ProcessRefs>, ) -> Self

Every process in processes starts at time zero, in list order.

Source

pub fn add_clock( &mut self, event: B::Event, signal: SignalRef, period: u64, initial_delay: u64, )

Source

pub fn schedule( &mut self, event: B::Event, signal: SignalRef, time: u64, value: u8, )

Source

pub fn step<E>( &mut self, executor: &mut E, ) -> Result<Option<u64>, SimulatorErrorCode>
where E: SimulationExecutor<Backend = B>,

Source

pub fn is_finished(&self) -> bool

Whether a process requested the end of the simulation.

Source

pub fn settle_at<E>( &mut self, executor: &mut E, time: u64, ) -> Result<Option<u64>, SimulatorErrorCode>
where E: SimulationExecutor<Backend = B>,

Settle externally driven state against the previous edge baseline even when no clock/reset signal is explicitly scheduled at this timestamp.

Source

pub fn time(&self) -> u64

Source

pub fn set_time(&mut self, time: u64)

Source

pub fn next_event_time(&self) -> Option<u64>

Time of the next scheduled event or process wakeup. None once a process has finished the simulation.

Source

pub fn clock_periods(&self) -> Vec<(usize, u64)>

Periodic clocks as (event id, period).

Source

pub fn snapshot(&self) -> SimulationSnapshot<B>

Capture the mutable scheduling state: time, pending events, clocks and the clock values edge detection compares against.

Source

pub fn restore( &mut self, snapshot: &SimulationSnapshot<B>, remap: impl FnMut(B::Event) -> Option<B::Event>, ) -> Result<(), B::Event>

Return to a state captured by Self::snapshot on a state built for the same design.

Event handles may point into the compiled code of the instance that took the snapshot, so remap translates each pending event into a handle of this instance. If an event cannot be translated, nothing is changed and that event is returned.

Source§

impl<B: SimBackend> SimulationState<B>

Source

pub fn export_schedule(&self, backend: &B) -> ScheduleParts<B>

Express the scheduling state with backend’s event handles.

Source

pub fn import_schedule(&mut self, parts: ScheduleParts<B>)

Replace the scheduling state with parts, whose handles belong to this state’s backend.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more