systemcomposer.rptgen.finder.StereotypeResult class

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

Search result for stereotypes

Since R2022b

Description

Search result object for information about a stereotype in a profile in a given System Composer™ architecture model.

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

Creation

result = StereotypeResult creates a search result object for a stereotype found by a systemcomposer.rptgen.finder.StereotypeFinder object.

Note

The find method of the systemcomposer.rptgen.finder.StereotypeFinder class creates objects of this type for each stereotype 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 stereotype

string

Name of stereotype, specified as a string. This property must be a valid MATLAB^® identifier.

Example: "HardwareComponent"

Data Types: string

Icon — Icon for stereotype

reporter object

Icon for stereotype, specified as a mlreportgen.dom.Image (MATLAB Report Generator) object.

Parent — Stereotype from which stereotype inherits properties

stereotype object

Stereotype from which stereotype inherits properties, specified as a systemcomposer.profile.Stereotype object.

Description — Description text for stereotype

string

Description text for stereotype, specified as a string.

Data Types: string

AppliesTo — Element type to which stereotype can be applied

"" (default) | "Component" | "Port" | "Connector" | "Interface" | "Allocation" | "Function" | "Requirement" | "Link"

Element type to which stereotype can be applied, specified as one of these options:

• "" to apply stereotype to all element types.

• "Component".

• "Port".

• "Connector".

• "Interface".

• "Allocation". For more information, see Create and Manage Allocations Interactively.

• "Function", which is only available for software architectures. For more information, see Apply Stereotypes to Functions of Software Architectures.

• "Requirement", to be used with a Requirements Toolbox™ license. For more information, see Customize Requirements and Links by Using Stereotypes (Requirements Toolbox).

• "Link", to be used with a Requirements Toolbox license.

Data Types: string

Properties — Properties

structure

Properties contained in stereotype and inherited from the stereotype base hierarchy, returned as a structure with fields:

• Name, returned as a string.

• Type, returned as a string.

• Index, returned as an integer.

• Unit, returned as a string.

• DefaultValue, returned as a string.

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 stereotype reporter

Version History

Introduced in R2022b