Out Bus Element — Control Systems/Sinks
Control_Systems/Sinks/Out_Bus_Element · 2 input / 1 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.
Out Bus Element
Control Systems / Sinks
Packs several named signals into one wider signal, so a subsystem can leave through a single port carrying all of them. y is the vertical stack of the inputs in port order – a [2,1] and a [3,1] element become one [5,1] bus – and each input's description label is the name of the element it contributes.
Ports
- Inputs – the bus elements, two by default and the count is user-editable. At least one is required. They may differ in row count but must all agree in column count, since the stack is vertical. The description label of each input is that element's NAME – it carries meaning here, it is not decoration, and it is what the generated code and the run messages call the element.
- Output – the bus: as many rows as all elements together, and the elements' shared column count. Wire it into a Subsystem Output Gate to send the whole bus out of the subsystem.
Elements
Element k occupies the rows its input contributed, in port order: the first input owns rows 0 upward, the second continues from there. An input whose description label is left empty is named element_k by position, so a partly-labelled block still works and still reads.
Parameters
- Port Name – the bus's own name, used to qualify the elements
(
OutBus.err) in generated code comments and run messages. It names something this block creates, so it is not looked up in the variables space. - Sampling Time (s) – zero or less inherits the solver's rate; a positive value runs the block at that period.
Code export
All ten targets: Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog and PLC Structured Text. The stack is unrolled at export time, so the generated code is plain assignment with no loop over ports, and each element's rows carry a comment naming the element they came from – which is the only thing a bus is once the types are gone.
Simulink bridge
No equivalent, and deliberately so. Simulink's Out Bus Element
carries exactly ONE element per block – its Element parameter
– and several blocks sharing a PortName add up to one bus. One
block here is therefore N blocks there, and the block catalog maps one type to
one type; registering the mapping anyway would export a bus of five elements as
its first element and lose the other four silently. Build the far side as N Out
Bus Element blocks sharing a port name, or export the bus as a plain Mux
into an Outport, which does cross.
Notes
- Algebraic, with no state – pure signal routing. Nothing is scaled, reordered or renamed on the way through; only the layout changes.
- Not a sink, despite the family: it has an output, and it is code-export verified like any other block that produces one.
- The output size is derived from the inputs, so it is only settled once the upstream blocks have resolved theirs.
Code facts#
| Fact | Value |
|---|---|
| registered type | Control_Systems/Sinks/Out_Bus_Element |
| family | Control_Systems/Sinks |
| solver environment class | ICoreBlock_0_Control_Systems_1_Sinks_2_Out_Bus_Element |
| source | src/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Sinks/Out_Bus_Element/ICoreBlock_0_Control_Systems_1_Sinks_2_Out_Bus_Element.cpp |
| header | src/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Sinks/Out_Bus_Element/ICoreBlock_0_Control_Systems_1_Sinks_2_Out_Bus_Element.h |
| default size on canvas | 40 × 80 px |
| ports at insert | 2 in, 1 out |
| code generators implemented | Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text |
Ports#
| # | Direction | Signal type | Description label |
|---|---|---|---|
| 1 | in | ICoreDouble | signal1 |
| 2 | in | ICoreDouble | signal2 |
| 3 | out | ICoreDouble | — |
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#
| Config variable | Default | Simulink parameter |
|---|---|---|
Port Name | OutBus | — |
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.
Simulink bridge#
| support | Support::None |
| Simulink path | — |
| port-count rule | PortsParam::None |
SampleTime parameter | yes |
| deliberately not crossed | CONFIG_PORT_NAME.c_str() |
Caveat (shown to the user): one ICore Out Bus Element packs every element of a bus, while Simulink's carries one element per block -- one block here is N blocks there, which the catalog's one-type-to-one-type mapping cannot express. Export the bus as a Mux into an Outport, or build the far side as N Out Bus Element blocks sharing a port name
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:
B0Ports lists 2 entries for 3 ports (2 in, 1 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#
| t | in ICoreDouble-Out-0 | in ICoreDouble-Out-0 | out ICoreDouble-Out-0 [2x1] entry 0 |
|---|---|---|---|
| 0 | -2 | -2 | [-2, -2] |
| 0.4 | 0.5 | 0.5 | [0.5, 0.5] |
| 0.8 | -2 | -2 | [-2, -2] |
| 1.2 | 0.5 | 0.5 | [0.5, 0.5] |
| 1.6 | -2 | -2 | [-2, -2] |
| 2 | 0.5 | 0.5 | [0.5, 0.5] |
| 2.4 | -2 | -2 | [-2, -2] |
| 2.8 | 0.5 | 0.5 | [0.5, 0.5] |
| 3.2 | -2 | -2 | [-2, -2] |
| 3.6 | 0.5 | 0.5 | [0.5, 0.5] |
| 4 | -2 | -2 | [-2, -2] |
| 4.4 | 0.5 | 0.5 | [0.5, 0.5] |
| 4.8 | -2 | -2 | [-2, -2] |
| 5.2 | 0.5 | 0.5 | [0.5, 0.5] |
Every 4th of 60 samples, from the table stimulus.
The same rig also ran:
| Stimulus | What it is | Output range |
|---|---|---|
impulse | Impulse: one sample of 1 at k = 5, 0 elsewhere (Repeating Sequence Stair) | 0 … 1 |
ramp | Ramp: slope 1 from t = 0 | 0 … 5.8 |
sine | Sine Wave: amplitude 1, 2 rad/s, no phase, no bias | -1 … 0.9996 |
step | Step: 0 -> 1 at t = 1 s | 0 … 1 |
Plotted: table — Repeating Sequence Stair: [-2 -1 -0.5 0 0.5 1 2 3], one entry per sample
Category static · sample time 0.1 · 60 steps · commit ccf005c8 · produced by docsSample --out <folder> --steps 60 · data docs/generated/samples/Control_Systems__Sinks__Out_Bus_Element.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).