Stateflow    
find

Return specified objects in this object at all levels of containment

Syntax

Description

Using combinations of specifier-value argument pairs, the find method returns objects in this object that match the specified criteria. The specifier-value pairs can be property based or based on other attributes of the object such as its depth of containment. Specifiers can also be logical operators (-and, -or, etc.) that combine other specifier-value pairs.

By default, the find command finds objects at all depths of containment within an object. You can specify the maximum depth of search with the -depth specifier. However, the zeroth level of containment, i.e., the searched object itself, is always included if it happens to satisfy the search criteria.

If no arguments are specified, the find command returns all objects of this object at all levels of containment.

Arguments

thisObject
 The object for which to find contained objects. Can be an object of type Root, Machine, State, Box, or Function.

'-and'
 No value is paired to this specifier. Instead, this specifier relates a previous specifier-value pair to a following specifier-value pair in an AND relation.
'-class'
 Following value is a string class name of the class to search for. Use this option to find all objects whose class exactly matches a given class. To allow matches for subclasses of a given class, use the -isa specifier. Classes are specified as the string name (e.g., 'Stateflow.State', 'Stateflow.Transition', etc.) or as a handle to the class (see the method classhandle).
'-depth'
 Following value is an integer depth to search, which can be 0,1,2,...,infinite. The default search depth is infinite.

    Note    Do not use the '-depth' switch with the find method for a machine object.

'-function'
 Following value is a handle to a function that evaluates each object visited in the search. The function must always return a logical scalar value that indicates whether or not the value is a match. If no property is specified, the function is passed the handle of the current object in the search. If a property is specified, the function is passed the value of that property.
In the following example, a function with handle f (defined in first line) is used to filter a find to return only those objects of type 'andState':
  • f = @(h) (strcmp(get(h,'type'), 'andState'));
objArray = thisObject.find('-function', f);
'-isa'
 Following value specifies the name of the type of objects to search for. Object types are specified as a string name (e.g., 'Stateflow.State', 'Stateflow.Transition', etc.) or as a handle to the object type (see method classhandle).
'-method'
 Following value is a string that specifies the name of a method belonging to the objects to search for.
'-not'
 No value is paired to this specifier. Instead, this specifier searches for the negative of the following specifier-value pair.
'-or'
 No value is paired to this specifier. Instead, this specifier relates the previous specifier-value pair to the following specifier-value pair in an OR relation.

    Note    If no logical operator is specified, -or is assumed.

'property'
 The specifier takes on the name of the property. Value is the string value of the specified property for the objects you want to find.
'-property'
 Following value is the string name of the property that belongs to the objects you want to find.
'-xor'
 No value is paired to this specifier. Instead, this specifier relates the previous specifier-value pair to the following specifier-value pair in an XOR relation.
'-regexp'
 No value follows this specifier. Instead, this specifier indicates that the value of the following specifier-value pair contains a regular expression.

Returns

objArray
 Array of objects found matching the criteria specified (see Arguments)

Example

If a Chart object c represents a Stateflow chart, the command states=c.find('-isa','Stateflow.State') returns an array, states, of all the states in the chart, and the command states=c.find('Name','A') returns an array of all objects whose Name property is 'A'.

If state A, which is represented by State object sA, contains two states, A1 and A2, and you specify a find command that finds all the states in A as follows,

then the above command finds three states: A, A1, and A2.

See Also

The methods findDeep and findShallow


  disp findDeep