systemcomposer.rptgen.finder.InterfaceResult Class

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

Search result for interfaces

Since R2022b

Description

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

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

Creation

result = InterfaceResult creates a search result object for an interface that you find by using a systemcomposer.rptgen.finder.InterfaceFinder object.

Note

The find method of the systemcomposer.rptgen.finder.InterfaceFinder class creates a search result object for each interface 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

InterfaceName — Name of interface

string

Name of interface, returned as a string.

Data Types: string

Elements — Elements of interface

structure

Elements of interface, returned as a structure.

These fields for data elements are returned as strings:

• Name

• Type

• Description

• Complexity

• Dimensions

• Maximum

• Minimum

These fields for value types are returned as strings:

• Name

• DataType

• Description

• Complexity

• Dimensions

• Maximum

• Minimum

These fields for service interfaces are returned as strings:

• Name

• FunctionPrototype

• FunctionArgument, returned as a structure with fields that are returned as strings:

  • Name

  • Type

  • Dimensions

  • Description

Data Types: struct

Ports — Ports information

structure

Ports information, returned as a structure with fields:

• InterfaceName

• PortName

• FullPortName

• Direction

Data Types: struct

Tag — Tag to associate with result

string

Tag to associate with result, specified as a string. You can use this property 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 interface reporter

Examples

Find Dictionaries and Interfaces in Architectures

Use the DictionaryFinder, DictionaryResult, InterfaceFinder, and InterfaceResult classes to create a report that finds all dictionaries and interfaces in a given architecture model.

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

Open the scKeylessEntrySystem project.

prj = openProject("scKeylessEntrySystem");
model_name = "KeylessEntryArchitecture";
mdl = systemcomposer.loadModel(model_name);

Create a report and append a title page and table of contents.

dataReport = slreportgen.report.Report(OutputPath=model_name + "_ArchitectureDataReport", ...
    CompileModelBeforeReporting=false);
append(dataReport,TitlePage(Title="Architectural Data in " + model_name));
append(dataReport,TableOfContents);

Create a chapter to contain all sections related to dictionaries.

dictionaryChapter = Chapter(Title="Dictionaries");

Find all dictionaries linked to the architecture model.

dictionaryFinder = DictionaryFinder(model_name);

while hasNext(dictionaryFinder)
    dictionary = next(dictionaryFinder);
    dictionarySection = Section(Title="Dictionary: " + dictionary.Name);
    append(dictionarySection, dictionary);    

Find all interfaces in the dictionary.

    interfaces = dictionary.Interfaces;
    for i=1:length(interfaces)
        interfaceFinder = InterfaceFinder(model_name);
        interfaceFinder.Filter = interfaces(i);
        interface = find(interfaceFinder);

Create a section for each interface in the dictionary.

        interfaceSection = Section(Title="Interface: " + interface.InterfaceName);
        append(interfaceSection, interface);
        append(dictionarySection, interfaceSection);
    end

    append(dictionaryChapter,dictionarySection);
end

Append the chapter to the report and view the generated report.

append(dataReport,dictionaryChapter);
close(dataReport);
rptview(dataReport);

Version History

Introduced in R2022b