Package: slreportgen.report
Simulink system input and output signal reporter
Create a reporter that reports on signals entering or leaving a Simulink® model or subsystem.
Note
To use a SystemIO
reporter in a report, you must create the report using
the slreportgen.report.Report
class.
The slreportgen.report.SystemIO
class is a handle
class.
slreportgen.report.SystemIO()
creates an empty
slreportgen.report.SystemIO
reporter object. Use the
Object
property to specify the model or subsystem to be reported.
By default, the reporter generates summary tables for the system inputs and outputs. The
input summary table lists the sources of the input signals. The output summary table lists
the destinations of the output signals. The reporter also generates a signal details
section that lists the properties of the input and output ports. Use the reporter
properties to customize the content and appearance of the generated report. For example,
use the DetailsReporter
property to customize the content and
appearance of the signal details section.
slreportgen.report.SystemIO(
creates a reporter for the model or subsystem specified by object
)object
.
See the Object
property.
slreportgen.report.SystemIO(
sets the reporter properties using name-value pairs. You can specify multiple name-value
pair arguments in any order. Enclose each property name in single or double quotes.Name,Value
)
The input and output signal properties reported by the SystemIO
reporter correspond to Simulink properties, which you can query by using get_param
. For example, the DataType
and
Dimensions
properties correspond to the Simulink
CompiledPortDataType
and CompiledPortDimensions
properties of the port handles.
For bus signals, Simulink determines the values of the CompiledPortDataType
and
CompiledPortDimensions
properties based on whether the signal is a
nonvirtual or virtual bus.