Main Content

filterDescription

Class: slcoverage.Filter
Namespace: slcoverage

Get description of coverage filter object

Since R2020a

expand all in page

Syntax

descr = filterDescription(filterObj)

Description

descr = filterDescription(filterObj) returns the description of the specified coverage filter.

Input Arguments

expand all

Coverage filter, specified as an slcoverage.Filter object.

Data Types: slcoverage.Filter

Output Arguments

expand all

Filter description, returned as a character array or string array.

Data Types: char | string

Examples

expand all

Open Script

This example shows how to use the slcoverage.Filter methods to set and get filter names and descriptions.

Create a new filter object by using the slcoverage.Filter class.

filt = slcoverage.Filter;

Set the filter name and description by using setFilterName and setFilterDescription, respectively.

setFilterName(filt,'myCovFilter');
setFilterDescription(filt,'Justify missing coverage for unreachable outcomes');

Get the filter name and description by using filterName and filterDescription with the filter object as the input.

filtName = filterName(filt)
filtDescr = filterDescription(filt)

filtName =

    'myCovFilter'


filtDescr =

    'Justify missing coverage for unreachable outcomes'

Alternatives

You can also create, edit, and view filters in Simulink®. See Create, Edit, and View Coverage Filter Rules for more information.

Version History

Introduced in R2020a

See Also

| | | | | | |

Topics