getDefaultSummaryTableTitle

Get default summary table title for finder result class

Since R2022a

Syntax

tableTitle = getDefaultSummaryTableTitle(resultObject)

tableTitle = getDefaultSummaryTableTitle(resultObject,TypeSpecificTitle=value)

Description

tableTitle = getDefaultSummaryTableTitle(resultObject) returns the default summary table title for the finder result class, resultObject.

tableTitle = getDefaultSummaryTableTitle(resultObject,TypeSpecificTitle=value) indicates whether to return the type-specific table title of the specified object.

Examples

Find Default Summary Table Title for SignalResult Object

This example shows how to access the default summary table title for a BlockResult object.

Import the required namespaces to avoid using long, fully qualified class names.

import slreportgen.finder.*

Load the model and search for blocks in the model. For a result object, print the default summary table title.

model_name = "vdp";
load_system(model_name)


finder = BlockFinder(model_name);
results = find(finder);

title1 = getDefaultSummaryTableTitle(results(1),TypeSpecificTitle=true)

title1 = 
"CustomCallbackButton Block Properties"

title2 = getDefaultSummaryTableTitle(results(2),TypeSpecificTitle=false)

title2 = 
"Block Properties"

Input Arguments

resultObject — Finder result object for which to return default title

finder result object

Finder result object for which to return the default summary table title, specified as an object of finder result class.

value — Whether to return type-specific summary table title

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

Whether to return a type-specific summary table title which is specific to the Type property of the finder result object, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Return a type-specific summary table title which is specific to the Type property of the finder result object.

• 0 (false) — Do not return a type-specific summary table title.

Output Arguments

tableTitle — Default table title for summarizing finder result object

string array

Default summary table title for finder result object, returned as a string array. Depending on the finder result class, the possible table titles are:

Finder Result Class	Table title with TypeSpecificTitle set to true	Table title with TypeSpecificTitle set to false
slreportgen.finder.BlockResult	<Block Type> Block Properties	Block Properties
slreportgen.finder.DataDictionaryResult	Data Dictionaries	Data Dictionaries
slreportgen.finder.DiagramElementResult	<Object Type> Properties	Object Properties
slreportgen.finder.DiagramResult	<Diagram Type> Properties	System Properties
slreportgen.finder.ModelVariableResult	Model Variables	Model Variables
slreportgen.finder.SignalResult	Signal Properties	Signal Properties
slreportgen.finder.FunctionReferenceResult	Functions	Functions

Version History

Introduced in R2022a