Documentation

find_system

Find systems, blocks, lines, ports, and annotations

Syntax

  • Objects = find_system
    example
  • Objects = find_system(System)
    example
  • Objects = find_system(Name,Value)
    example
  • Objects = find_system(System,Name,Value)
    example

Description

example

Objects = find_system returns loaded systems and their blocks, including subsystems.

example

Objects = find_system(System) returns the specified system and its blocks.

example

Objects = find_system(Name,Value) returns loaded systems and the objects in those systems that meet the criteria specified by one or more Name,Value pair arguments. You can use this syntax to specify search constraints and to search for specific parameter values. Specify the search constraints before the parameter and value pairs.

example

Objects = find_system(System,Name,Value) returns the objects in the specified system that meet the specified criteria.

Input Arguments

collapse all

System — System to searchpath name | cell array of path names | handle | vector of handles

System to search, specified as the full system path name, a cell array of system path names, a handle, or a vector of handles.

Example: 'MyModel/Subsystem1'

Example: {'vdp','fuelsys'}

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'SearchDepth','0','LookUnderMasks','none','BlockType','Goto' searches in loaded systems, excluding masked subsystems, for Goto blocks.

When you use the find_system function, Name,Value pair arguments can include search constraints and parameter name and value pairs. You can specify search constraints in any order, but they must precede the parameter name and value pairs.

See Model Parameters and Block-Specific Parameters for the lists of model and block parameters.

The table lists the possible search constraint pairs. Braces indicate default values.

Name

Value Type

Description

'BlockDialogParams'

string

Search block dialog box parameters for the specified value. This pair, like parameter and value pairs, must follow the other search constraint pairs.

'CaseSensitive'

{'on'} | 'off'

If 'on', search considers case when matching search strings.

'FindAll'

'on' | {'off'}

If 'on', search includes lines, ports, and annotations within systems. find_system returns a vector of handles when this option is set to 'on', regardless of how you specify System.

'FollowLinks'

'on' | {'off'}

If 'on', search follows links into library blocks. If you do not specify a system to search, find_system includes loaded libraries in the results, whether you set 'FollowLinks' to 'on' or 'off'. You can use 'FollowLinks' with 'LookUnderMasks' to update library links in subsystems. See Update Library Links in a Subsystem.

'IncludeCommented'

'on' | {'off'}

Specify whether to include commented blocks in the search.

'LoadFullyIfNeeded'

{'on'} | 'off'

If 'on', attempts to load any partially loaded models. If 'off', disables model loading. Use this pair, for example, to prevent load warnings.

'LookUnderMasks'

{'graphical'}

Search includes masked subsystems that have no workspaces and no dialogs.

'none'

Search skips masked subsystems.

'functional'

Search includes masked subsystems that do not have dialogs.

'all'

Search includes all masked subsystems.

'RegExp'

'on' | {'off'}

If 'on', search treats search expressions as regular expressions. To learn more about MATLAB® regular expressions, see Regular Expressions.

'SearchDepth'

positive integer string

Restricts the search depth to the specified level ('0' for loaded systems only, '1' for blocks and subsystems of the top-level system, '2' for the top-level system and its children, etc.). The default is all levels.

'Variants'

This search constraint applies only to variant subsystems and model variants.

{'ActiveVariants'}

Search in only the active variant subsystems.

'AllVariants'

Search in all variants.

'ActivePlusCodeVariants'

Search all variants if any generate preprocessor conditionals. Otherwise, search only the active variant.

Output Arguments

collapse all

Objects — Matching objectscell array of path names | vector of handles

Matching objects found, returned as:

  • A cell array of path names if you specified System as a path name or cell array of path names, or if you did not specify a system

  • A vector of handles if you specified System as a handle or vector of handles

Examples

Find Loaded Systems and Their Blocks

Return the names of all loaded systems and their blocks.

load_system('vdp')
find_system

Returns loaded systems and libraries, including vdp.

Find Specific System and Its Blocks

Return vdp system and its blocks.

load_system({'vdp','fuelsys'})
find_system('vdp')
ans = 

    'vdp'
    'vdp/Fcn'
    'vdp/More Info'
    'vdp/More Info/Model Info'
    'vdp/Mu'
    'vdp/Mu1'
    'vdp/Mux'
    'vdp/Product'
    'vdp/Scope'
    'vdp/Sum'
    'vdp/x1'
    'vdp/x2'
    'vdp/Out1'
    'vdp/Out2'

Return Names of Loaded Models

Return the names of only the loaded models, i.e., block diagrams. This command returns library names as well, because libraries are treated as models.

vdp
open_bd = find_system('type','block_diagram')
	ans = 
    'vdp'
    'simulink'

Search Children of Subsystem

Return the names of all Goto blocks that are children of the Unlocked subsystem in the sldemo_clutch system.

sldemo_clutch
find_system('sldemo_clutch/Unlocked','SearchDepth',1,'BlockType','Goto')
ans =
		'sldemo_clutch/Unlocked/Goto'
		'sldemo_clutch/Unlocked/Goto1'

Search Using Multiple Criteria

Search in the vdp system and return the names of all Gain blocks whose Gain value is set to 1.

vdp
find_system('vdp','BlockType','Gain','Gain','1')
ans =
		'vdp/Mu'

Return Lines and Annotations as Handles

Get the handles of all lines and annotations in the vdp system. With 'FindAll', the function returns handles regardless of how you specify the system to search.

vdp
L = find_system('vdp','FindAll','on','type','line')
A = find_system('vdp','FindAll','on','type','annotation')
L =

   1.0e+03 *

    2.0740
    2.0730
    2.0720
    2.0710
    2.0700
    2.0690
    2.0680
    2.0670
    2.0660
    2.0650
    2.0640
    2.0630
    2.0620
    2.0610
    2.0600
    2.0590
    2.0580


A =

   1.0e+03 *

    2.0760
    2.0750

Search for Specific Block Parameter Value

Find any block dialog box parameters with a value of 0 in the vdp and fuelsys systems.

load_system({'vdp','fuelsys'})
find_system({'vdp','fuelsys'},'BlockDialogParams','0')
ans = 

    'vdp/x2'
    'vdp/Out1'
    'vdp/Out2'
    'fuelsys/Constant2'
    'fuelsys/Constant4'
    'fuelsys/Constant5'
    'fuelsys/engine …'
    'fuelsys/engine …'
    'fuelsys/engine …'
    'fuelsys/engine …'
				.
				.
				.

Search Using Regular Expressions

Find all blocks in the top level of the currently loaded systems with a block dialog parameter value that starts with 3.

load_system({'fuelsys','vdp'})
find_system('SearchDepth','1','regexp','on','BlockDialogParams','^3')
ans =
		'fuelsys/Nominal…'
		'vdp/Scope'

Regular Expression Search for Partial Match

When you search using regular expressions, you can specify a part of the string you want to match to return all objects that contain that string.

Find all the inport and outport blocks in the sldemo_clutch model.

sldemo_clutch
find_system('sldemo_clutch','regexp','on','blocktype','port')

Update Library Links in a Subsystem

In this example, myModel contains a single subsystem, which is a library link. After the model was last opened, a Gain block was added to the corresponding subsystem in the library.

Open the model. Use find_system with 'FollowLinks' set to 'off'. The command does not follow the library links into the subsystem and returns only the subsystem at the top level.

open_system('myModel')
find_system(bdroot,'LookUnderMasks','on','FollowLinks', 'off')
ans = 

    'myModel'
    'myModel/Subsystem'

Use find_system with 'FollowLinks' set to 'on'. find_system updates the library links and returns the block in the subsystem.

find_system(bdroot,'LookUnderMasks','on','FollowLinks','on')
Updating Link: myModel/Subsystem/Gain
Updating Link: myModel/Subsystem/Gain

ans = 

    'myModel'
    'myModel/Subsystem'
    'myModel/Subsystem/Gain'

Return Values as Handles

Provide the system to find_system as a handle. Search for block dialog box parameters with a value of 0.

If you make multiple calls to get_param for the same block, then using the block handle is more efficient than specifying the full block path as a string.

vdp
sys = get_param('vdp','Handle');
find_system(sys,'BlockDialogParams','0')
ans =
		14.0001
		15.0001
		16.0001

Related Examples

Introduced before R2006a

Was this topic helpful?