Enum WaveContainer

pub enum WaveContainer {
    Wellen(Box<WellenContainer>),
    Empty,
    Cxxrtl(Box<Mutex<CxxrtlContainer>>),
}

Variants

Wellen(Box<WellenContainer>)

Empty

A wave container that contains nothing. Currently, the only practical use for this is a placehodler when serializing and deserializing wave state.

Cxxrtl(Box<Mutex<CxxrtlContainer>>)

Implementations

impl WaveContainer

pub fn new_waveform(hierarchy: Arc<Hierarchy>) -> Self

pub fn new_remote_waveform( server_url: String, hierarchy: Arc<Hierarchy>, ) -> Self

pub fn __new_empty() -> Self

Creates a new empty wave container. Should only be used as a default for serde. If no wave container is present, the WaveData should be None, rather than this being Empty

pub fn tick(&self)

pub fn wants_anti_aliasing(&self) -> bool

pub fn is_fully_loaded(&self) -> bool

Returns true if all requested signals have been loaded. Used for testing to make sure the GUI is at its final state before taking a snapshot.

pub fn variable_names(&self) -> Vec<String>

Returns the full names of all variables in the design.

pub fn variables(&self) -> Vec<VariableRef>

pub fn variables_in_scope(&self, scope: &ScopeRef) -> Vec<VariableRef>

Return all variables (excluding parameters) in a scope.

pub fn parameters_in_scope(&self, scope: &ScopeRef) -> Vec<VariableRef>

Return all parameters in a scope.

pub fn no_variables_in_scope(&self, scope: &ScopeRef) -> bool

Return true if there are no variables or parameters in the scope.

pub fn load_variables<S: AsRef<VariableRef>, T: Iterator<Item = S>>( &mut self, variables: T, ) -> Result<Option<LoadSignalsCmd>>

Loads multiple variables at once. This is useful when we want to add multiple variables in one go.

pub fn load_parameters(&mut self) -> Result<Option<LoadSignalsCmd>>

Load all the parameters in the design so that the value can be displayed.

pub fn on_signals_loaded( &mut self, res: LoadSignalsResult, ) -> Result<Option<LoadSignalsCmd>>

Callback for when wellen signals have been loaded. Might lead to a new load variable command since new variables might have been requested in the meantime.

pub fn variable_meta<'a>( &'a self, variable: &'a VariableRef, ) -> Result<VariableMeta>

pub fn query_variable( &self, variable: &VariableRef, time: &BigUint, ) -> Result<Option<QueryResult>>

Query the value of the variable at a certain time step. Returns None if we do not have any values for the variable. That generally happens if the corresponding variable is still being loaded.

pub fn update_variable_ref(&self, variable: &VariableRef) -> Option<VariableRef>

Looks up the variable by name and returns a new reference with an updated id if the variable is found.

pub fn scope_names(&self) -> Vec<String>

Returns the full names of all scopes in the design.

pub fn metadata(&self) -> MetaData

pub fn root_scopes(&self) -> Vec<ScopeRef>

pub fn child_scopes(&self, scope: &ScopeRef) -> Result<Vec<ScopeRef>>

pub fn max_timestamp(&self) -> Option<BigUint>

pub fn scope_exists(&self, scope: &ScopeRef) -> bool

pub fn get_scope_tooltip_data(&self, scope: &ScopeRef) -> String

Returns a human readable string with information about a scope. The scope name itself should not be included, since it will be prepended automatically.

pub fn simulation_status(&self) -> Option<SimulationStatus>

Returns the simulation status for this wave source if it exists. Wave sources which have no simulation status should return None here, otherwise buttons for controlling simulation will be shown

pub fn unpause_simulation(&self)

If WaveContainer::simulation_status is Some(SimulationStatus::Paused), attempt to unpause the simulation otherwise does nothing

pub fn pause_simulation(&self)

See WaveContainer::unpause_simulation

pub fn wellen_add_body( &mut self, body: BodyResult, ) -> Result<Option<LoadSignalsCmd>>

Called for wellen container, when the body of the waveform file has been parsed.

pub fn body_loaded(&self) -> bool