padv.builtin.query.FindModels Class
Namespace: padv.builtin.query
Superclasses: padv.Query, padv.builtin.query.FindArtifacts
Query for finding models
Description
The padv.builtin.query.FindModels class provides a query that can return
models in your project folder. By default, the query finds the Simulink® and System Composer™ models in your project folder. You can automatically include or exclude certain
files by using the optional name-value arguments.
You can use this query in your process model to find models for your tasks to iterate over or use as inputs.
The padv.builtin.query.FindModels class is a handle class.
Creation
Description
query = padv.builtin.query.FindModels()
query = padv.builtin.query.FindModels(Name=Value)padv.builtin.query.FindModels(IncludePathRegex =
"modelPrefix.*\.slx") creates a query that can find SLX files where the path
contains modelPrefix.
The padv.builtin.query.FindModels class also has other properties, but you cannot set
those properties during query creation.
Name-Value Arguments
Properties
Methods
Examples
You can use the FindModels query in your task
definition to find models that your tasks can iterate over
(IterationQuery) or use as inputs (InputQueries).
For example, suppose that you only want to run the Check Modeling
Standards task for SLX model files where the model name contains
Control.
Open a project. For this example, open the Process Advisor example project.
processAdvisorExampleStart
padv.builtin.query.FindModels as the
IterationQuery.In the process model, reconfigure which models the Check Modeling
Standards task iterates over by updating the
IterationQuery for the task. The associated built-in task is
padv.builtin.task.RunModelStandards. You can update the code to find the
models in the project by using the built-in query
padv.builtin.query.FindModels, but use the
IncludePathRegex argument to have the query only return SLX files
where the model name contains
Control.
if includeModelStandardsTask maTask = pm.addTask(padv.builtin.task.RunModelStandards()); ... % Specify which set of artifacts to run for maTask.IterationQuery = ... padv.builtin.query.FindModels(IncludePathRegex = "Control.*\.slx"); end
For this example, when you save the process model and refresh Process
Advisor, the model AHRS_Voter.slx does not appear under the
task title in Process Advisor because AHRS_Voter.slx does not include
Control in the path.
Although you typically use a query inside your process model, you can
run an instance of the FindModels query outside of your process model to
confirm which artifacts the query returns.
Open a project. For this example, you can open the Process Advisor example project.
processAdvisorExampleStart
Create an instance of the query. You can use the arguments of the query to filter
the query results. For example, you can use the IncludeLabel
argument to have the query only return artifacts that use the Design
project label from the Classification project label
category.
q = padv.builtin.query.FindModels(... IncludeLabel = {"Classification","Design"});
Run the query and inspect the array of artifacts that the query returns.
run(q)
ans =
1×5 Artifact array with properties:
Type
Parent
ArtifactAddressCapabilities and Limitations
This table identifies functionality that is supported by the query.
| Functionality | Supported? | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Input query for task | Only when the query properties
Note The
| ||||||||||||||
Iteration query for task | Yes. The query supports iteration artifacts with these artifact types:
|
