Instrument Control Toolbox

instrfind

Return instrument objects from memory to the MATLAB workspace

Syntax

• out = instrfind 
  out = instrfind('PropertyName',PropertyValue,...) 
  out = instrfind(S)
  out = instrfind(obj,'PropertyName',PropertyValue,...)
  

Arguments

'PropertyName'	A property name for obj.
PropertyValue	A property value supported by PropertyName.
S	A structure of property names and property values.
obj	An instrument object, or an array of instrument objects.
out	An array of instrument objects.

Description

out = instrfind returns all valid instrument objects as an array to out.

out = instrfind('PropertyName',PropertyValue,...) returns an array of instrument objects whose property names and property values match those specified.

out = instrfind(S) returns an array of instrument objects whose property names and property values match those defined in the structure S. The field names of S are the property names, while the field values are the associated property values.

out = instrfind(obj,'PropertyName',PropertyValue,...) restricts the search for matching property name/property value pairs to the instrument objects listed in obj.

Remarks

You must specify property values using the same format as the get function returns. For example, if get returns the Name property value as MyObject, instrfind will not find an object with a Name property value of myobject. However, this is not the case for properties that have a finite set of string values. For example, instrfind will find an object with a Parity property value of Even or even. You can use the propinfo function to determine if a property has a finite set of string values.

You can use property name/property value string pairs, structures, and cell array pairs in the same call to instrfind.

Example

Suppose you create the following two GPIB objects.

• g1 = gpib('ni',0,1);
  g2 = gpib('ni',0,2);
  g2.EOSCharCode = 'CR';
  fopen([g1 g2])
  

You can use instrfind to return instrument objects based on property values.

• out1 = instrfind('Type','gpib');
  out2 = instrfind({'Type','EOSCharCode'},{'gpib','CR'});
  

You can also use instrfind to return cleared instrument objects to the MATLAB workspace.

• clear g1 g2
  newobjs = instrfind
  
  Instrument Object Array
     Index:   Type:          Status:     Name:  
     1        gpib           open        GPIB0-1
     2        gpib           open        GPIB0-2
  

Assign the instrument objects their original names.

• g1 = newobjs(1);
  g2 = newobjs(2);
  

Close both g1 and g2.

• fclose(newobjs)
  

See Also

Functions

clear, get, propinfo

instrcreate

instrhelp