Parallel Computing Toolbox™

UserData - Specify data to associate with object

Description

You configure UserData to store data that you want to associate with an object. The object does not use this data directly, but you can access it using the get function or dot notation.

UserData is stored in the local MATLAB client session, not in the job manager, job data location, or worker. So, one MATLAB client session cannot access the data stored in this property by another MATLAB client session. Even on the same machine, if you close the client session where UserData is set for an object, and then access the same object from a later client session via the job manager or job data location, the original UserData is not recovered. Likewise, commands such as

clear all
clear functions

will clear an object in the local session, permanently removing the data in the UserData property.

Characteristics

Values

The default value is an empty vector.

Examples

Suppose you create the job object job1.

job1 = createJob(jm);

You can associate data with job1 by storing it in UserData.

coeff.a = 1.0;
coeff.b = -1.25;
job1.UserData = coeff
get(job1,'UserData')
ans = 
    a: 1
    b: -1.2500

Type

UserName