slreportgen.report.TruthTable Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

Truth table reporter

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(PropertyName=Value) creates a truth table reporter with additional options specified by one or more PropertyName=Value pair arguments. Name is a property name and Value is the corresponding value. You can specify several name-value 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 logical 1 (true) or 0 (false). When you specify:

IncludeConditionTableHeader — Include headers in condition table

1 (true) (default) | 0 (false)

Specify whether to include headers in the truth table condition table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The report includes column headers in the truth table.

• 0 (false) — The report does not include column headers in the truth table.

IncludeConditionTableRowNumber — Include row numbers in condition table

1 (true) (default) | 0 (false)

Specify whether to include row numbers in the truth table condition table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Each row of the condition table starts with a row number.

• 0 (false) — The condition table does not include row numbers.

IncludeConditionTableConditionCol — Include condition column in condition table

1 (true) (default) | 0 (false)

Specify whether to include the condition column in the truth table condition table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The report includes the conditions that trigger the decisions.

• 0 (false) — The report does not include the conditions that trigger the decisions.

IncludeConditionTableDescriptionCol — Include description column in condition table

1 (true) (default) | 0 (false)

Specify whether to include the description column in the truth table condition table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The report includes descriptions of the truth table conditions.

• 0 (false) — The report does not include 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

1 (true) (default) | 0 (false)

Specify whether to include headers in the truth table action table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The action table includes the column headers, such as "Description" that identify the contents of each column.

• 0 (false) — The action table does not include column headers.

IncludeActionTableRowNumber — Include row numbers in action table

1 (true) (default) | 0 (false)

Specify whether to include row numbers in the truth table action table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The row numbers are included in the action table.

• 0 (false) — The row numbers are not included in the action table.

If this property is true, each row of the action table starts with a row number.

IncludeActionTableActionCol — Include action column in action table

1 (true) (default) | 0 (false)

Specify whether to include the action column in the truth table action table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Each row of the action table lists the executable action statements for each action.

• 0 (false) — The action column is not included in the action table.

IncludeActionTableDescriptionCol — Include description column in action table

1 (true) (default) | 0 (false)

Specify whether to include the description column in the truth table action table, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Each row of the action table contains a description of the corresponding action.

• 0 (false) — The description column is not included in the action table.

ActionTableReporter — Reporter for truth table action table

BaseTable reporter (default) | custom reporter

Reporter used by the TruthTable reporter to create the action table of the truth 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

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

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

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

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. 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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true
Dependent	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the 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 specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

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 an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
slreportgen.report.TruthTable.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.TruthTable.customizeReporter	Create reporter from slreportgen.report.TruthTable class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.TruthTable at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.TruthTable.getClassFolder	Get location of folder that contains slreportgen.report.TruthTable class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Add Truth Table to a PDF Report

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

model = "sf_climate_control";
openExample(model);

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)
rptview(rpt)

Slice Truth Table Condition Table

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

model = "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)
rptview(rpt)

Version History

Introduced in R2018b