find

Identify specified objects in hierarchy

Syntax

objArray = find(location,Name,Value)

objArray = find(location,"-not",Name,Value)

objArray = find(location,"-regexp",Name,Value)

objArray = find(location,___,logicalOp,___)

Description

objArray = find(location,Name,Value) returns an array of objects in the hierarchy of location that match the criteria specified by one or more Name,Value pair arguments.

objArray = find(location,"-not",Name,Value) returns objects that do not match the criteria specified by the subsequent Name,Value pair argument.

objArray = find(location,"-regexp",Name,Value) indicates that the subsequent Name,Value pair argument contains a regular expression. For more information, see Regular Expressions.

objArray = find(location,___,logicalOp,___) combines search criteria by using one of these logical operations:

• "-and" — Results must match both search criteria.

• "-or" — Results must match at least one criterion.

• "-xor" — Results must match exactly one criterion.

When using various logical operators, -and has the highest precedence, while -or and -xor are right-associative. If no logical operator is specified, then -and is assumed.

Examples

Find States in a Chart

Find all states in the chart ch.

states = find(ch,"-isa","Stateflow.State")

Find States Named A

Find all states in the chart ch whose Name is A.

statesNamedA = find(ch,"-isa","Stateflow.State","-and","Name","A")

Find Objects with Name Starting with A

Find all objects in the chart ch whose Name property starts with the letter A.

startsWithA = find(ch,"-regexp","Name","^A")

Find Nongraphical Objects

Find all objects in the chart ch that do not have an object function called fitToView.

nongraphical = find(ch,"-not","-method","fitToView")

Use Function to Specify Search Criteria

Find all charts in a Simulink^® model called myModel.

f = @(h) (strcmp(h.Machine.Name,"myModel"));
ch = find(sfroot,"-isa","Stateflow.Chart","-and","-function",f);

Input Arguments

location — Location to search

Simulink.Root object | Stateflow.Chart object | Stateflow.State object | ...

Location to search, specified as a Stateflow^® API object of one of these types:

• Simulink.Root

• Simulink.BlockDiagram

• Stateflow.Box

• Stateflow.Chart

• Stateflow.EMChart

• Stateflow.EMFunction

• Stateflow.Function

• Stateflow.Machine

• Stateflow.State

• Stateflow.SLFunction

• Stateflow.StateTransitionTableChart

• Stateflow.TruthTable

• Stateflow.TruthTableChart

Name-Value Arguments

Example: find(ch,"Name","A") finds all objects in the chart ch whose Name property is A.

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN. In addition to the Name,Value arguments listed here, you can use the name of a Stateflow API property and its corresponding value. For more information, see Summary of Stateflow API Objects and Properties.

-isa — Type of object

character vector

Type of object for which to search, specified as the comma-separated pair consisting of "-isa" and a character vector or a class handle for an object.

Example: find(ch,"-isa","Stateflow.State") finds all states in the chart ch.

Example: find(ch,"-isa",class(object)) finds all objects of the same type as object.

-depth — Depth of search

inf (default) | scalar nonnegative integer

Depth of search in the object hierarchy, specified as the comma-separated pair consisting of "-depth" and a scalar nonnegative integer or inf.

Example: find(ch,"-depth",2) finds all objects in the top two levels of the hierarchy of the chart ch.

-function — Filtering function

function handle

Filtering function, specified as the comma-separated pair consisting of "-function" and a function handle. The function evaluates each object visited in the search and returns a logical scalar value that indicates whether the object is a match.

Example: find(ch,"-function",f) finds all objects for which f is true.

-method — Object function

character vector

Object function that belongs to the objects for which to search, specified as the comma-separated pair consisting of "-method" and a character vector.

Example: find(ch,"-method","dialog") finds all objects in the chart ch that have an object function called dialog.

-property — Property

character vector

Property that belongs to the objects for which to search, specified as the comma-separated pair consisting of "-property" and a character vector.

Example: find(ch,"-property","HasOutputData") finds all objects in the chart ch that have a property called HasOutputData.

Output Arguments

objArray — Search results

array

Search results, returned as an array of Stateflow API objects.

Tips

• Using the find function on Simulink.Root, Simulink.BlockDiagram, or Stateflow.Machine objects can return Simulink objects that match the search criteria you specify. For example, this command can return a Simulink subsystem or block named ABC:

  find(sfroot,"Name","ABC")

• Opening a main model that refers to a linked Stateflow chart does not guarantee that the Stateflow API can find the linked chart. To access the objects in a linked library chart, first load the library model into the Simulink workspace by performing one of these tasks:

  • Open the library model.

  • View a linked subsystem or block in the main model.

  • Compile or simulate the model.

  • Call the function find_system (Simulink) with the FollowLinks argument set to on:

    find_system(FollowLinks="on");

Version History

Introduced before R2006a