slreportgen.report.TruthTable class

Package: slreportgen.report
Superclasses: slreportgen.report.Reporter

Truth table reporter

Since R2018b

Description

Create a Simulink^® truth table block or Stateflow^® truth table object reporter.

Note

To use a TruthTable reporter in a report, you must create the report using the slreportgen.report.Report class.

The slreportgen.report.TruthTable class is a handle class.

Creation

Description

rptr = TruthTable() creates an empty TruthTable reporter. Use its properties to specify the truth table on which to report and specify report options and format.

rptr = TruthTable(truthtableobj) creates a TruthTable reporter for the truth table specified by truthtableobj, which can be either a block or a Stateflow object. By default, the reporter generates a table of the conditions and actions of the truth table.

rptr = TruthTable(Name=Value) creates a truth table reporter with additional options specified by one or more Name=Value pair arguments. Name is a property name and Value is the corresponding value. You can specify several name-value pair arguments in any order as Name1=Value1,...,NameN=ValueN.

Input Arguments

truthtableobj — Truth table object

Simulink Truth Table block path | Simulink Truth Table block handle | Stateflow Truth Table handle

See the Object property.

Properties

Object — Truth table block or object

Simulink Truth Table block path | Simulink Truth Table block handle | Stateflow Truth Table handle

Simulink Truth Table block or Stateflow truth table object, specified as a path or handle.

IncludeConditionTableHeader — Include headers in condition table

true (default) | false

Specify whether to include headers in the truth table condition table, specified as a logical. If this property is true, the report includes column headers that identify the contents of the table columns.

IncludeConditionTableRowNumber — Include row numbers in condition table

true (default) | false

Specify whether to include row numbers in the truth table condition table, specified as a logical. If this property is true, each row of the condition table starts with a row number.

IncludeConditionTableConditionCol — Include condition column in condition table

true (default) | false

Specify whether to include the condition column in the truth table condition table, specified as a logical. If this property is true, the report includes the conditions that trigger the decisions.

IncludeConditionTableDescriptionCol — Include description column in condition table

true (default) | false

Specify whether to include the description column in the truth table condition table, specified as a logical. If this property is true, the report includes descriptions of the truth table conditions.

ConditionTableReporter — Reporter for truth table condition table

BaseTable reporter (default) | custom reporter

Reporter used by the TruthTable reporter to create the truth table condition table. This property is set by default to an instance of a BaseTable reporter.

Use the associated BaseTable reporter properties to customize the appearance of the condition table. If the condition table is too wide to fit legibly on a page, use the MaxCols property of the BaseTable reporter to generate the condition table as a set of table slices that fit legibly.

Note

The TruthTable reporter always repeats the first two columns of the condition table in each slice. It does not use the RepeatCols property of the BaseTable or custom reporter.

IncludeActionTableHeader — Include headers in action table

true (default) | false

Specify whether to include headers in the truth table action table, specified as a logical. If this property is true, the action table includes the column headers, such as "Description" that identify the contents of each column.

IncludeActionTableRowNumber — Include row numbers in action table

true (default) | false

Specify whether to include row numbers in the truth table action table, specified as a logical. If this property is true, each row of the action table starts with a row number.

IncludeActionTableActionCol — Include action column in action table

true (default) | false

Specify whether to include the action column in the truth table action table, specified as a logical. If this property is true, each row of the action table lists the executable action statements for each action.

IncludeActionTableDescriptionCol — Include description column in action table

true (default) | false

Specify whether to include the description column in the truth table action table, specified as a logical. If this property is true, each row of the action table contains a description of the corresponding action.

ActionTableReporter — Reporter for truth table action table

BaseTable reporter (default) | custom reporter

Reporter used by the TruthTable reporter to create the truth table's action table. This property is set by default to an instance of a BaseTable reporter. You can customize the appearance of the action table by changing the properties of this table reporter or by replacing it with a customized version of a BaseTable reporter.

TemplateSrc — Source of template for this reporter

[] (default) | character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified as one of these options:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

• DOM document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which this reporter is appended. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

TemplateName — Name of template for this reporter

character vector | string scalar

Name of template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template source (TemplateSrc) for this reporter.

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID or as an mlreportgen.dom.LinkTarget object. A character vector or string scalar value is converted to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Methods

Public Methods

slreportgen.report.TruthTable.createTemplate	Create truth table template
slreportgen.report.TruthTable.customizeReporter	Create custom truth table reporter class
slreportgen.report.TruthTable.getClassFolder	Location of truth table class definition file
copy	Create copy of a Simulink reporter object and make deep copies of certain property values
getImpl	Get implementation of reporter

Examples

Add Truth Table to a PDF Report

import slreportgen.report.*
import mlreportgen.report.*

model_name = 'sf_climate_control';
openExample(model_name);

rpt = slreportgen.report.Report('output','pdf');
truthtableobj = 'sf_climate_control/ClimateController';

chapter = Chapter(truthtableobj);
rptr = TruthTable(truthtableobj);
rptr.IncludeConditionTableRowNumber = false;
add(chapter,rptr)
add(rpt,chapter)

close(rpt)
close_system(model_name)
rptview(rpt)

Slice Truth Table Condition Table

import slreportgen.report.*
import mlreportgen.report.*

model_name = 'sf_climate_control';
openExample('sf_climate_control');

rpt = slreportgen.report.Report('output','pdf');
truthtableobj = 'sf_climate_control/ClimateController';

chapter = Chapter(truthtableobj);
rptr = TruthTable(truthtableobj);
rptr.IncludeConditionTableRowNumber = false;
rptr.ConditionTableReporter.MaxCols = 4;
add(chapter,rptr)
add(rpt,chapter)

close(rpt)
close_system(model_name)
rptview(rpt)

Version History

Introduced in R2018b