SignalIntegritySheet

Return sheet object of given Signal Integrity Toolbox interface object

Since R2023a

Description

The SignalIntegritySheet class object returns the sheet object from a given SignalIntegrityInterface object. You can get the current sheet, any specific sheet in the interface, or all the interface sheets.

Creation

Syntax

sh=int.CurrentSheet

sh=int.Sheets(i)

sh=int.Sheets

Description

sh=int.CurrentSheet returns a SignalIntegritySheet class object corresponding to the current sheet of the SignalIntegrityInterface object int.

sh=int.Sheets(i) returns a SignalIntegritySheet class object corresponding to the i-th sheet of the SignalIntegrityInterface object int.

sh=int.Sheets returns the SignalIntegritySheet class objects corresponding to all the sheets of the SignalIntegrityInterface object int.

Properties

Name — Name of current sheet

string

Name of the current sheet, specified as a string.

Included — Determine whether sheet is included in simulation

true | false

Determine whether the sheet is included in the simulation, specified as either true or false.

CaseMode — Determine whether case mode is turned on during simulation

true | false

Determine whether the case mode is turned on during the simulation, specified as either true or false.

CurrentState — Object representing current state

class object

SignalIntegrityState object representing current state in the sheet, specified as a class object.

Designators — Designator objects in the sheet

list

Designator objects in the sheet, specified as a list. Each designator have these properties:

• Name — The name of the designator.

• Stimulus — Associated stimulus pattern.

• Part — Part name.

• ModelType — Input. output, I/O, or repeater.

• UI — Associated unit interval.

You can return a designator on the sheet by using the designator function.

Differential — Determine whether sheet is differential or single-ended

true | false

Determine whether the sheet is differential or single-ended, specified as either true or false.

Widebus — Determine whether sheet is widebus sheet

true | false

Determine whether sheet is a widebus sheet or not, specified as either true or false.

Simulations — Objects representing all simulations in sheet

class object

SignalIntegritySimulation object(s) representing all the simulations that ran in the sheet, specified as a [1xN] class object. N represents the number of simulations.

SolutionSpace — Pre-layout solution space for current state

table

Pre-layout solution space for the current state, specified as a [NxM] table. N represents the number of solution space variables.

Results — Results of simulations ran in current sheet

table

Results of the simulations that ran in the current sheet being observed, specified as a [Nx(M+4)] table. N and M represent the number of simulations and the number of result variables, respectively.

SimulationParameters — Simulation parameters for the current interface

dictionary

Simulation parameters for the current interface, specified as a dictionary.

States — Object(s) representing all states in current sheet

class object

SignalIntegrityState object(s) representing all the states in the current sheet, specified as [1xN] class object. N represents the number of states.

ParentInterface — Parent interface object

class object

SignalIntegrityInterface object representing the parent interface, specified as a class object.

Object Functions

designator

Return designator on sheet

Version History

Introduced in R2023a