systemcomposer.rptgen.finder.InterfaceResult class

Package: 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 found by a systemcomposer.rptgen.finder.InterfaceFinder object.

Note

The find method of the systemcomposer.rptgen.finder.InterfaceFinder class creates objects of this type 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 with fields.

For data elements:

• Name, returned as a string.

• Type, returned as a string.

• Description, returned as a string.

• Complexity, returned as a string.

• Dimensions, returned as a string.

• Maximum, returned as a string.

• Minimum, returned as a string.

For value types:

• Name, returned as a string.

• DataType, returned as a string.

• Description, returned as a string.

• Complexity, returned as a string.

• Dimensions, returned as a string.

• Maximum, returned as a string.

• Minimum, returned as a string.

For service interfaces:

• Name, returned as a string.

• FunctionPrototype, returned as a string.

• FunctionArgument, returned as a structure with fields:

  • Name, returned as a string.

  • Type, returned as a string.

  • Dimensions, returned as a string.

  • Description, returned as a string.

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. 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 interface reporter

Version History

Introduced in R2022b