systemcomposer.rptgen.finder.ConnectorResult class

Package: systemcomposer.rptgen.finder
Superclasses: mlreportgen.finder.Result (MATLAB Report Generator)

Search result for connectors

Since R2022b

Description

Search result object for information about a connector in a System Composer™ architecture model.

The systemcomposer.rptgen.finder.ConnectorResult class is a handle class.

Creation

result = ConnectorResult creates a search result object for a connector found by a systemcomposer.rptgen.finder.ConnectorFinder object.

Note

The find method of the systemcomposer.rptgen.finder.ConnectorFinder class creates objects of this type for each connector that it finds. You do not need to create this object yourself.

Properties

Object — Universal unique identifier of result element

string

Universal unique identifier (UUID) of result element, returned as a string.

Data Types: string

Name — Name of connector

string

Name of connector, returned as a string.

Data Types: string

Parent — Parent component of connector

string

Parent component of connector, returned as a string.

Data Types: string

SourcePort — Source port of connector

string

Source port of connector, returned as a string.

Data Types: string

DestinationPort — Destination port of connector

string

Destination port of connector, returned as a string.

Data Types: string

Stereotypes — Stereotypes on connector

array of strings

Stereotypes on connector, returned as an array of strings.

Data Types: string

Tag — Tag to associate with result

string

Tag to associate with result, specified as a string. This property allows you to attach additional information to a result. You can set this property to any value that meets your requirements.

Data Types: string

Methods

Public Methods

getReporter

Get connector reporter

Examples

Generate Connector Result Report

Use the ConnectorFinder and ConnectorResult classes to generate a report.

import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.rptgen.finder.*

scExampleSmallUAV
model_name = "scExampleSmallUAVModel";
model = systemcomposer.loadModel(model_name);
rpt = slreportgen.report.Report(output="ConnectorResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title",sprintf('Connectors in %s Model',model_name)));
add(rpt,TableOfContents);

connectorFinder = ConnectorFinder(model_name);
connectorFinder.Filter = "Component";
connectorFinder.ComponentName = "scExampleSmallUAVModel/Flight Support Components";
chapter = Chapter("Title","Connectors");
result = find(connectorFinder);
add(rpt,chapter);

for r = result
    reporter = getReporter(r);
    append(rpt,reporter);
end

close(rpt);
rptview(rpt)

Version History

Introduced in R2022b