padv.builtin.query.FindExternalCodeCache Class

Namespace: padv.builtin.query
Superclasses: padv.Query, padv.builtin.query.FindArtifacts

Query for finding external code cache files in project folder

Description

This class requires CI/CD Automation for Simulink Check.

The padv.builtin.query.FindExternalCodeCache class provides a query that can return the external code cache files (.slxc.bk) 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 artifacts for your tasks to use as inputs. For example, you can use this query to the find external code cache files that you generate using the built-in task padv.builtin.task.GenerateCode. The built-in task padv.builtin.task.GenerateCode generates an external code cache when you specify the task property GenerateExternalCodeCache as true. To unpack the code generation target from the cache files, you can use the utility function padv.util.unpackExternalCodeCache.

The padv.builtin.query.FindExternalCodeCache class is a handle class.

Creation

Description

query = padv.builtin.query.FindExternalCodeCache() creates a query for finding the external code cache files (.slxc.bk) in your project folder.

example

query = padv.builtin.query.FindExternalCodeCache(Name = queryName) specifies a new name, queryName, for the query object. Each query in the process model must have a unique name.

The padv.builtin.query.FindExternalCodeCache class also has other properties, but you cannot set those properties during query creation.

Input Arguments

expand all

`queryName` — Unique identifier for query
string

Unique identifier for query, specified as a string.

This argument specifies the value for the Name property.

Example: "FindMyExternalCodeCache"

Data Types: string

Properties

expand all

`ArtifactType` — Type of artifact
`"slxc_bak_file"` (default) | `"other_file"` | ...

Type of artifact, specified as one or more of the values in this table. To specify multiple values, use a cell array.

Category	Artifact Type	Description
MATLAB^®	`"m_class"`	MATLAB class
	`"m_file"`	MATLAB file
	`"m_func"`	MATLAB function
	`"m_method"`	MATLAB class method
	`"m_property"`	MATLAB class property
Model Advisor	`"ma_config_file"`	Model Advisor configuration file
Model Advisor	`"ma_justification_file"`	Model Advisor justification file
Other	`"coder_code_files"`	Code files
Other	`"other_file"`	Other file
Process Advisor	`"padv_dep_artifacts"`	Related artifacts that current artifact depends on
Process Advisor	`"padv_output_file"`	Process Advisor output file
Project	`"project"`	Current project file
Requirements	`"mwreq_item"`	Requirement (since R2024b)
	`"sl_req"`	Requirement (for R2024a and earlier)
	`"sl_req_file"`	Requirement file
	`"sl_req_table"`	Requirements Table
Stateflow^®	`"sf_chart"`	Stateflow chart
	`"sf_graphical_fcn"`	Stateflow graphical function
	`"sf_group"`	Stateflow group
	`"sf_state"`	Stateflow state
	`"sf_state_transition_chart"`	Stateflow state transition chart
	`"sf_truth_table"`	Stateflow truth table
Simulink^®	`"sl_block_diagram"`	Block diagram
	`"sl_data_dictionary_file"`	Data dictionary file
	`"sl_embedded_matlab_fcn"`	MATLAB function
	`"sl_block_diagram"`	Block diagram
	`"sl_library_file"`	Library file
	`"sl_model_file"`	Simulink model file
	`"sl_protected_model_file"`	Protected Simulink model file
	`"sl_subsystem"`	Subsystem
	`"sl_subsystem_file"`	Subsystem file
	`"sl_subsystem"`	Subsystem
System Composer™	`"zc_block_diagram"`	System Composer architecture
	`"zc_component"`	System Composer architecture component
	`"zc_file"`	System Composer architecture file
Tests	`"harness_info_file"`	Harness info file
	`"sl_harness_block_diagram"`	Harness block diagram
	`"sl_harness_file"`	Test harness file
	`"sl_test_case"`	Simulink Test™ case
	`"sl_test_case_result"`	Simulink Test case result
	`"sl_test_file"`	Simulink Test file
	`"sl_test_iteration"`	Simulink Test iteration
	`"sl_test_iteration_result"`	Simulink Test iteration result
	`"sl_test_report_file"`	Simulink Test result report
	`"sl_test_result_file"`	Simulink Test result file
	`"sl_test_resultset"`	Simulink Test result set
	`"sl_test_seq"`	Test Sequence
	`"sl_test_suite"`	Simulink Test suite
	`"sl_test_suite_result"`	Simulink Test suite result

Example: "slxc_bak_file"

Example: ["slxc_bak_file" "other_file"]

`IncludeLabel` — Find artifacts with specific project label
cell array

Find artifacts with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

`ExcludeLabel` — Exclude artifacts with specific project label
cell array

Exclude artifacts with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

`IncludePathRegex` — Find artifacts where path matches regular expression pattern
string | character vector

Find artifacts where the path matches a regular expression pattern, specified as a character vector or string. IncludePathRegex expects UNIX^®-style path separators.

If you want to use a literal path, use IncludePath instead. You can specify either IncludePath or IncludePathRegex but not both.

Example: "modelNamePrefix_.*\.slxc.bk"

Data Types: char | string

`ExcludePathRegex` — Exclude artifacts where path matches regular expression pattern
string | character vector

Exclude artifacts where the path matches a regular expression pattern, specified as a string or a character vector. ExcludePathRegex expects UNIX-style path separators.

If you want to use a literal path, use ExcludePath instead. You can specify either ExcludePath or ExcludePathRegex but not both.

Example: "modelNamePrefix_.*\.slxc.bk"

Data Types: char | string

`FilterSubFileArtifacts` — Filter out sub-file artifacts from query results
`1` (`true`) (default) | `0` (`false`)

Filter out sub-file artifacts from query results, specified as a numeric or logical 1 (true) or 0 (false).

A sub-file is a part of a larger file. For example, a subsystem is a sub-file of a model file.

Example: false

Data Types: logical

`InProject` — Include only artifacts added to project
`0` (`false`) (default) | `1` (`true`)

Include only artifacts that have been added to the project, specified as a numeric or logical 1 (true) or 0 (false).

For more information about how to add or remove files from a project, see Add Files to the Project.

Example: true

Data Types: logical

`Title` — Query title
`"All generated external code cache files"` (default) | string | character vector

Query title, specified as a string or a character vector.

Example: "Find my external code cache files"

Data Types: string

`DefaultArtifactType` — Default artifact type returned by query
`"slxc_bak_file"` (default) | `"other_file"` | ...

Default artifact type returned by the query, specified as one or more of the values in this table. To specify multiple values, use an array.

Category	Artifact Type	Description
MATLAB	`"m_class"`	MATLAB class
	`"m_file"`	MATLAB file
	`"m_func"`	MATLAB function
	`"m_method"`	MATLAB class method
	`"m_property"`	MATLAB class property
Model Advisor	`"ma_config_file"`	Model Advisor configuration file
Model Advisor	`"ma_justification_file"`	Model Advisor justification file
Other	`"coder_code_files"`	Code files
Other	`"other_file"`	Other file
Process Advisor	`"padv_dep_artifacts"`	Related artifacts that current artifact depends on
Process Advisor	`"padv_output_file"`	Process Advisor output file
Project	`"project"`	Current project file
Requirements	`"mwreq_item"`	Requirement (since R2024b)
	`"sl_req"`	Requirement (for R2024a and earlier)
	`"sl_req_file"`	Requirement file
	`"sl_req_table"`	Requirements Table
Stateflow	`"sf_chart"`	Stateflow chart
	`"sf_graphical_fcn"`	Stateflow graphical function
	`"sf_group"`	Stateflow group
	`"sf_state"`	Stateflow state
	`"sf_state_transition_chart"`	Stateflow state transition chart
	`"sf_truth_table"`	Stateflow truth table
Simulink	`"sl_block_diagram"`	Block diagram
	`"sl_data_dictionary_file"`	Data dictionary file
	`"sl_embedded_matlab_fcn"`	MATLAB function
	`"sl_block_diagram"`	Block diagram
	`"sl_library_file"`	Library file
	`"sl_model_file"`	Simulink model file
	`"sl_protected_model_file"`	Protected Simulink model file
	`"sl_subsystem"`	Subsystem
	`"sl_subsystem_file"`	Subsystem file
	`"sl_subsystem"`	Subsystem
System Composer	`"zc_block_diagram"`	System Composer architecture
	`"zc_component"`	System Composer architecture component
	`"zc_file"`	System Composer architecture file
Tests	`"harness_info_file"`	Harness info file
	`"sl_harness_block_diagram"`	Harness block diagram
	`"sl_harness_file"`	Test harness file
	`"sl_test_case"`	Simulink Test case
	`"sl_test_case_result"`	Simulink Test case result
	`"sl_test_file"`	Simulink Test file
	`"sl_test_iteration"`	Simulink Test iteration
	`"sl_test_iteration_result"`	Simulink Test iteration result
	`"sl_test_report_file"`	Simulink Test result report
	`"sl_test_result_file"`	Simulink Test result file
	`"sl_test_resultset"`	Simulink Test result set
	`"sl_test_seq"`	Test Sequence
	`"sl_test_suite"`	Simulink Test suite
	`"sl_test_suite_result"`	Simulink Test suite result

Example: "slxc_bak_file"

Example: ["slxc_bak_file" "other_file"]

`Parent` — Initial query that runs before iteration query
`string.empty()` (default) | `padv.Query` | `Name` of `padv.Query` object

You cannot use FindExternalCodeCache as an iteration query, so the build system does not use the parent query.

`Name` — Unique identifier for query
string

Unique identifier for query, specified as a string.

Example: "FindMyExternalCodeCache"

Data Types: string

`ShowFileExtension` — Show file extensions for returned artifacts
`0` (`false`) | `1` (`true`)

Show file extensions in the Alias property of returned artifacts, specified as a numeric or logical 1 (true) or 0 (false). The Alias property controls the display name for the artifact in the Tasks column in Process Advisor.

By default, queries strip file extensions from the Alias property of each task iteration artifact. To show file extensions for all artifacts in the Tasks column, select the project setting Show file extensions. To keep file extensions in the results for a specific query, specify the query property ShowFileExtension as true.

Example: true

Data Types: logical

`SortArtifacts` — Setting for automatically sorting artifacts by address
`true` or `1` (default) | `false` or `0`

Setting for automatically sorting artifacts by address, specified as a numeric or logical 1 (true) or 0 (false). When a query returns artifacts, the artifacts should be in a consistent order. By default, the build system sorts artifacts by the artifact address.

Alternatively, you can sort artifacts in a different order by overriding the internal sortArtifacts method in a subclass that defines a custom sort behavior. For an example, see Sort Artifacts in Specific Order.

The build system automatically calls the sortArtifacts method when using the process model. The sortArtifacts method expects two input arguments: a padv.Query object and a list of padv.Artifact objects returned by the run method. The sortArtifacts method should return a list of sorted padv.Artifact objects.

Example: SortArtifacts = false

Data Types: logical

`FunctionHandle` — Handle to function that function-based query runs
`function_handle`

Handle to the function that a function-based query runs, specified as a function_handle.

If you define your query functionality inside a function and you or the build system call run on the query, the query runs the function specified by the function_handle.

The built-in queries are defined inside classes and do not use the FunctionHandle.

Example: FunctionHandle = @FunctionForQuery

Data Types: function_handle

Methods

expand all

Specialized Public Methods

This class overrides the following inherited methods.

run

Run query to find the artifacts that meet the criteria specified by the query.

The query returns a padv.Artifact object or an array of padv.Artifact objects that represent those artifacts.

Note

You do not need to manually invoke this method inside your process model. The build system automatically invokes the run method to find artifacts.

The run method inside this built-in query runs on a query object obj and returns artifacts artifacts. If you inherit from this built-in query, make sure to use the same method signature inside your custom query:

function artifacts = run(obj,~)
    ...
end

Examples

collapse all

Find and Unpack Cache Files for Task in Process

You can use the FindExternalCodeCache query in your task definition to find and unpack external code cache files. For example, suppose your team generates code in parallel by generating an external code cache, downstream tasks that depend on the generated code need to unpack the generated code target before performing the main task action. If you have a custom task that depends on that generated code, you can find the external code cache files by using the built-in query FindExternalCodeCache and unpack the code generation target by using the utility function padv.util.unpackExternalCodeCache.

Inside your task definition, you can find external code cache files by creating and running a FindExternalCodeCache query object. For example:

% Before main task action, access the generated code
% by finding and unpacking the external code cache
q = padv.builtin.query.FindExternalCodeCache;
artifactsArray = run(q);
    if ~isempty(artifactsArray)
        padv.util.unpackExternalCodeCache(artifactsArray)
    end

% <definition for main task action that uses the generated code>

For more information about parallel code generation and external code caches, see the GenerateExternalCodeCache property for the built-in task padv.builtin.task.GenerateCode. The external code cache allows your team to generate code in parallel while maintaining up-to-date task results.

Test `FindExternalCodeCache` Query Outside Process Model

Although you typically use a query inside your process model, you can run an instance of the FindExternalCodeCache query outside of your process model to confirm which artifacts the query returns.

Open the parallel code generation example.

processAdvisorParallelExampleStart

Generate code by running a code generation task iteration. For example, run the code generation task on the reference model OuterLoop_Control.

runprocess(Tasks = "padv.builtin.task.GenerateCode", ...
    FilterArtifact = fullfile("02_Models","OuterLoop_Control", ...
    "specification","OuterLoop_Control.slx"));

Find the external code cache file by using the built-in query.

q = padv.builtin.query.FindExternalCodeCache;
artifactsArray = run(q);

Unpack the cache file.

padv.util.unpackExternalCodeCache(artifactsArray);

Capabilities and Limitations

This table identifies functionality that is supported by the query.

Functionality	Supported?
Input query for task	Yes.
Iteration query for task	No.

padv.builtin.query.FindExternalCodeCache Class

Description

Creation

Description

Input Arguments

queryName — Unique identifier for query string

Properties

ArtifactType — Type of artifact "slxc_bak_file" (default) | "other_file" | ...

IncludeLabel — Find artifacts with specific project label cell array

ExcludeLabel — Exclude artifacts with specific project label cell array

IncludePathRegex — Find artifacts where path matches regular expression pattern string | character vector

ExcludePathRegex — Exclude artifacts where path matches regular expression pattern string | character vector

FilterSubFileArtifacts — Filter out sub-file artifacts from query results 1 (true) (default) | 0 (false)

InProject — Include only artifacts added to project 0 (false) (default) | 1 (true)

Title — Query title "All generated external code cache files" (default) | string | character vector

DefaultArtifactType — Default artifact type returned by query "slxc_bak_file" (default) | "other_file" | ...

Parent — Initial query that runs before iteration query string.empty() (default) | padv.Query | Name of padv.Query object

Name — Unique identifier for query string

ShowFileExtension — Show file extensions for returned artifacts 0 (false) | 1 (true)

SortArtifacts — Setting for automatically sorting artifacts by address true or 1 (default) | false or 0

FunctionHandle — Handle to function that function-based query runs function_handle

Methods

Specialized Public Methods

Examples

Find and Unpack Cache Files for Task in Process

Test FindExternalCodeCache Query Outside Process Model

Capabilities and Limitations

See Also

WeChat

`queryName` — Unique identifier for query
string

`ArtifactType` — Type of artifact
`"slxc_bak_file"` (default) | `"other_file"` | ...

`IncludeLabel` — Find artifacts with specific project label
cell array

`ExcludeLabel` — Exclude artifacts with specific project label
cell array

`IncludePathRegex` — Find artifacts where path matches regular expression pattern
string | character vector

`ExcludePathRegex` — Exclude artifacts where path matches regular expression pattern
string | character vector

`FilterSubFileArtifacts` — Filter out sub-file artifacts from query results
`1` (`true`) (default) | `0` (`false`)

`InProject` — Include only artifacts added to project
`0` (`false`) (default) | `1` (`true`)

`Title` — Query title
`"All generated external code cache files"` (default) | string | character vector

`DefaultArtifactType` — Default artifact type returned by query
`"slxc_bak_file"` (default) | `"other_file"` | ...

`Parent` — Initial query that runs before iteration query
`string.empty()` (default) | `padv.Query` | `Name` of `padv.Query` object

`Name` — Unique identifier for query
string

`ShowFileExtension` — Show file extensions for returned artifacts
`0` (`false`) | `1` (`true`)

`SortArtifacts` — Setting for automatically sorting artifacts by address
`true` or `1` (default) | `false` or `0`

`FunctionHandle` — Handle to function that function-based query runs
`function_handle`

Test `FindExternalCodeCache` Query Outside Process Model