Generated reference › Scope — Control Systems/Sinks
kind: generated#block#control-systems-sinks

Scope — Control Systems/Sinks

Control_Systems/Sinks/Scope · 1 input / 0 output port(s) at insert · exports to Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text

Description#

The block's own DESCRIPTION_HTML, rendered verbatim — the same text the config dialog's info panel and the library navigator show. Fix a wrong sentence in the block's .cpp (R-D9), never here.

Scope

Control Systems / Sinks

Plots whatever reaches it against simulation time, live, on the chart attached to the block. One trace per scalar channel: a [3,1] input draws three lines, and every input port contributes its own channels in port order.

Ports

  • Inputs – one by default, and the count is user-editable. Any signal size is accepted.
  • No outputs – the Scope is a pure sink and passes nothing on.

Parameters

  • Sampling Time (s) – how often a point is taken. Zero or less inherits the solver's rate; a positive value samples the trace at that period.

Notes

  • The traces live inside the chart and are cleared at the start of every run. To keep a run's data for later analysis, use the Signal Recorder, which saves it into the variables space as a time series.
  • On an infinite simulation the chart streams and keeps a rolling window rather than the whole history.

Code export

All ten targets: Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog and PLC Structured Text – but a deployable target has no display, so what each emits is not a plot. The nine console targets print the sampled values per step. PLC Structured Text emits comments only, naming the exact signal array entries to tap, since ST has no console; attach an HMI or trace there instead.

Simulink bridge

Import and export, mapped to simulink/Sinks/Scope. There is no parameter behind the width on either side: the port count becomes Simulink's NumInputPorts, and an imported count becomes this port list. "Sampling Time (s)" goes to SampleTime, as on every block.

Code facts#

FactValue
registered typeControl_Systems/Sinks/Scope
familyControl_Systems/Sinks
solver environment classICoreBlock_0_Control_Systems_1_Sinks_2_Scope
sourcesrc/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Sinks/Scope/ICoreBlock_0_Control_Systems_1_Sinks_2_Scope.cpp
headersrc/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Sinks/Scope/ICoreBlock_0_Control_Systems_1_Sinks_2_Scope.h
default size on canvas70 × 70 px
ports at insert1 in, 0 out
code generators implementedPython, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text

Ports#

#DirectionSignal typeDescription label
1inICoreDouble

Ports the constructor creates. A block whose port list changes with its configuration adds or removes ports at load time; the count above is the one a freshly inserted block has.

Configuration variables#

No config variable beyond the Sampling Time (s) every block carries.

Every block also carries Sampling Time (s) from ICoreBlockSolverEnvironment: zero or less inherits the solver's rate, a positive value runs the block at that period.

supportSupport::Both
Simulink pathsimulink/Sinks/Scope
port-count rulePortsParam::ScopeNumInputs
SampleTime parameteryes

Catalog contract: src/ICoreSDK/ICoreCoder/ICoreCommandSystem/SimulinkBridge/ICoreSimulinkBlockCatalog.h

Description vs code#

The checker has a blind spot here — it could not resolve something (a grouped port bullet, a computed config name), which is reported and never counted as a pass. A reader has to settle it:

  • B0 Ports lists 2 entries for 1 port (1 in, 0 out) — grouped, or one undocumented? a reader must say

The verdict above is tools/docs/check_block_descriptions.py (P7.1), which compares LISTS. It cannot read a sentence: "stateless" on a block with a state, an initial-value semantic the recursion does not implement, a "not synthesizable" caveat the HDL banner contradicts. That is the agent audit (P7.3) on BLOCK_DESCRIPTION_AUDIT.md, and this tool's green is not a substitute for one.

Sample results#

tin ICoreDouble-Out-0out ICoreDouble-In-0
000
0.400
0.800
1.211
1.611
211
2.411
2.811
3.211
3.611
411
4.411
4.811
5.211

Every 4th of 60 samples, from the step stimulus.

The same rig also ran:

StimulusWhat it isOutput range
impulseImpulse: one sample of 1 at k = 5, 0 elsewhere (Repeating Sequence Stair)0 … 1
rampRamp: slope 1 from t = 00 … 5.8
sineSine Wave: amplitude 1, 2 rad/s, no phase, no bias-1 … 0.9996
tableRepeating Sequence Stair: [-2 -1 -0.5 0 0.5 1 2 3], one entry per sample-2 … 3

Plotted: step — Step: 0 -> 1 at t = 1 s

Category sink · sample time 0.1 · 60 steps · commit ccf005c8 · produced by docsSample --out <folder> --steps 60 · data docs/generated/samples/Control_Systems__Sinks__Scope.json · the SVG is generated from those numbers by tools/docs/plot_svg.py, so it is a run and not a drawing (R-D10).