Learn more about SimEvents

sedb.blkinfo - Package: sedb

Block information in discrete-event simulation

Syntax

blkinfo(blkid) blkinfo(blkname) blk_struct = blkinfo(...)

Description

blkinfo(blkid) displays information about the SimEvents block with identifier blkid. To obtain a list of blocks and their identifiers, use sedb.blklist.

blkinfo(blkname) displays information about the SimEvents block with path name blkname.

blk_struct = blkinfo(...) returns a structure that stores information about the block.

The following blocks are exceptions that do not provide information:

Conn
Discrete Event Inport
Discrete Event Outport
Discrete Event Subsystem
Discrete Event Signal to Workspace
Event-Based Random Number
Event-Based Sequence
Initial Value
Instantaneous Event Counting Scope
Subsystem Configuration

Outputs

blk_struct

Structure that stores information about the block. The following table describes the blk_struct fields and the blocks for which each field appears.

Field Block Description

Time All blocks Current simulation time

Block All blocks Path name of the block

BlockID All blocks Block identifier

BlockType All blocks Type of block

Capacity All queue and server blocks Number of entities that the block can store at any one time

SelectedInputPort Input Switch Index of selected entity input port

SelectedOutputPort Output Switch Index of selected entity output port

GateStatus Enabled Gate 'open' or 'closed'

InputEntity Replicate Identifier of the entity that the block is replicating

CurrentReplica Replicate Identifier of the copy of the input entity that the block created and that is about to advance

Status Replicate, Entity Combiner, and Entity Splitter
Status of block.
Values for Replicate Block:
'Inactive'
'Replicating X/Y'. X is the index of the entity output port through which the replica will depart. Y is the Number of entity output ports parameter of the block
Values for Entity Combiner Block:
'Inactive'
'Combining'
Values for Entity Splitter Block:
'Inactive'
'Splitting'

MemoryValue Signal Latch Value of the internal memory of the block

Count Entity Departure Counter Number of entities that have departed from this block and arrived at subsequent storage blocks, since the simulation start or the last reset, whichever occurred later.

Entities All blocks that possess an entity input port
Structure array, of which each element has these fields:
ID — Entity identifier
Status (queue and server blocks only) — Status of the entity with respect to the block.
Entity Status Values in Queue Blocks:
'Advancing'
'Queuing'
'Queued'
'Timed Out'
Entity Status Values in Server Blocks:
'Advancing'
'In Service'
'Service Completed'
'Preempted'
'Timed Out'
Event (server blocks only) — Identifier of the service completion event for the entity
EventTime (server blocks only) — Time of the service completion event for the entity
TimeInQueue (queue blocks only) — Length of time the entity has been in the queue

Examples

View information about a block:

Begin a debugger session for a particular model. At the MATLAB command prompt, enter:
```
sedebug('sedemo_start_timer_read_timer')
```

Proceed in the simulation. At the sedebug>> prompt, enter:

tbreak 2.51
cont

The partial output indicates that the server is about to execute a service completion event:

Hit b1 : Breakpoint for first operation at or after time 2.510000

%==============================================================================%
Executing ServiceCompletion Event (ev8)               Time = 2.581301297500028
: Entity = en4                                        Priority = 1
: Block  = Infinite Server

View information about the block that is about to execute the event:

blkname = gceb
blkid = gcebid

The output is:

blkname =

sedemo_start_timer_read_timer/Infinite Server


blkid =

blk7

Proceed further in the simulation:

step

The output shows that the entity is about to depart from the server:

%..........................................................................%
    Entity Advancing (en4)
    : From = Infinite Server
    : To   = Read Timer

Use the identifier, blkid, to get information about the block and the status of entities in it:

% Display information in Command Window.
blkinfo(blkid)
% Store information in structure.
blkdetails = blkinfo(blkid)
% Store status of entities in cell array.
blkentities = {blkdetails.Entities.Status}'

The output is:

Infinite Server Current State                         T = 2.581301297500028
Block (blk7): Infinite Server

Entities (Capacity = Inf): 
 Pos     ID        Status                   Event     EventTime
 1       en2       In Service               ev4       2.7303849396254689
 2       en4       Advancing                ev8       2.581301297500028
 3       en5       In Service               ev10      2.974736350905304


blkdetails = 

         Time: 2.5813
        Block: 'sedemo_start_timer_read_timer/Infinite Server'
      BlockID: 'blk7'
    BlockType: 'Infinite Server'
     Capacity: Inf
     Entities: [1x3 struct]


blkentities = 

    'In Service'
    'Advancing'
    'In Service'

Get more information about one of the entities by using data from the blkdetails structure as an input argument to the eninfo function:
```
adv_eninfo = eninfo(blkdetails.Entities(1).ID);
time_in_system = adv_eninfo.Timers.ElapsedTime
```
The output is:
```
time_in_system =

    1.5813
```
End the debugger session. At the sedebug>> prompt, enter:
```
sedb.quit
```