systemcomposer.rptgen.finder.ViewResult class

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

Search result for views

Since R2022b

Description

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

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

Creation

result = ViewResult creates a search result object for a view found by a systemcomposer.rptgen.finder.ViewFinder object.

Note

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

string

Name of view, specified as a string.

Example: "NewView"

Data Types: string

Description — Description of view

string

Description of view, specified as a string.

Data Types: string

Select — Selection query

string

Selection query associated with view, specified as a string.

Data Types: string

GroupBy — Grouping criteria

string array of properties

Grouping criteria, specified as a string array of properties in the form "<profile>.<stereotype>.<property>".

Example: ["AutoProfile.MechanicalComponent.mass","AutoProfile.MechanicalComponent.cost"]

Elements — Elements in view

array of component objects

Elements in view, returned as an array of systemcomposer.arch.Component objects.

SubGroups — Subgroups in view

array of element group objects

Subgroups in view, returned as an array of systemcomposer.view.ElementGroup objects.

Data Types: char | string

Snapshot — Snapshot of view

reporter object

Custom snapshot reporter, specified as a mlreportgen.report.FormalImage (MATLAB Report Generator) object.

Color — Color of view

string

Color of view, specified as a string. The color can be the name "blue", "black", or "green", or it can be an RGB value encoded in a hexadecimal string: "#FF00FF" or "#DDDDDD". An invalid color results in an error.

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

Version History

Introduced in R2022b