getDefaultSummaryProperties

Get list of default summary table properties for a finder result class

Since R2022a

Syntax

propList = getDefaultSummaryProperties(resultObject)

propList = getDefaultSummaryProperties(resultObject,TypeSpecificProperties=value)

Description

propList = getDefaultSummaryProperties(resultObject) returns the default summary table properties for the finder result class, resultObject.

propList = getDefaultSummaryProperties(resultObject,TypeSpecificProperties=value) indicates whether to include the type-specific properties.

Examples

Find Default Properties to Report

Find the default properties included in the summary table reporter for a finder result object.

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

import slreportgen.finder.*

Load the model vdp and search for signals in the model. For each result object, print the associated default summary table properties.

model_name = "vdp";
load_system(model_name)

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

props = getDefaultSummaryProperties(results(1))

props = 1x5 string
    "Name"    "Description"    "Source"    "NonvirtualDestination"    "DataType"

Input Arguments

resultObject — Finder result object for which to list default properties

finder result object

Finder result object for which to list the default summary table properties, specified as an object of a finder result class.

value — Include type specific properties

true (default) | false

Whether to return type-specific properties of the finder result object, specified as true or false.

Output Arguments

propList — List of default summary table properties

string array

List of default summary table properties, returned as a string array. Default properties for the result classes are:

Finder Result Class	Property List When TypeSpecificProperties Is true	Property List When TypeSpecificProperties set to true
slreportgen.finder.BlockResult	Name Parent Block dialog properties for the block represented by the finder result object	Name Parent
slreportgen.finder.DataDictionaryResult	This class does not have any type-specific properties.	Name DataSources
slreportgen.finder.DiagramElementResult	The default properties depend on the type of finder result object: For Stateflow® objects, the reported properties are the same properties reported by the slreportgen.report.StateflowObjectProperties reporter For other objects, the reported properties are the same properties reported by the slreportgen.report.SimulinkObjectProperties reporter	Name Type
slreportgen.finder.DiagramResult	The default properties depend on the type of finder result object: For Stateflow objects, reported properties are the same properties reported by the slreportgen.report.StateflowObjectProperties reporter For other objects, the reported properties are the same properties reported by the slreportgen.report.SimulinkObjectProperties reporter	Name Description
slreportgen.finder.ModelVariableResult	This class does not have any type-specific properties.	Name Class Source SourceType
slreportgen.finder.SignalResult	This class does not have any type-specific properties.	Name Description Source NonvirtualDestination DataType
slreportgen.finder.FunctionReferenceResult	This class does not have any type-specific properties.	Name Calling blocks Calling expressions

Version History

Introduced in R2022a