Learn more about Parallel Computing Toolbox

simplematlabpooljob - Define MATLAB pool job behavior and properties when using local or third-party scheduler

Constructor

createMatlabPoolJob

Container Hierarchy

Parent	`ccsscheduler`, `genericscheduler`, `localscheduler`, `lsfscheduler`, `mpiexec`, `pbsproscheduler`, or `torquescheduler` object
Children	`simpletask` object

Description

A simplematlabpooljob object contains all the information needed to define what each lab does as part of the complete job execution. A MATLAB pool job uses one worker in a MATLAB pool to run a parallel job on the other labs of the pool. A simplematlabpooljob object is used only with a local or third-party scheduler.

Methods

cancel	Cancel job or task
createTask	Create new task in job
destroy	Remove job or task object from parent and memory
diary	Display or save Command Window text of batch job
findTask	Task objects belonging to job object
getAllOutputArguments	Output arguments from evaluation of all tasks in job object
load	Load workspace variables from batch job
submit	Queue job in scheduler
wait	Wait for job to finish or change state
waitForState	Wait for object to change state

Properties

Configuration	Specify configuration to apply to object or toolbox function
CreateTime	When task or job was created
FileDependencies	Directories and files that worker can access
FinishTime	When task or job finished
ID	Object identifier
JobData	Data made available to all workers for job's tasks
MaximumNumberOfWorkers	Specify maximum number of workers to perform job tasks
MinimumNumberOfWorkers	Specify minimum number of workers to perform job tasks
Name	Name of job manager, job, or worker object
Parent	Parent object of job or task
PathDependencies	Specify directories to add to MATLAB worker path
StartTime	When job or task started
State	Current state of task, job, job manager, or worker
SubmitTime	When job was submitted to queue
Tag	Specify label to associate with job object
Task	First task contained in MATLAB pool job object
Tasks	Tasks contained in job object
UserData	Specify data to associate with object
UserName	User who created job