backgroundEvaluationManager

Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

backgroundEvaluationManager [-interrupt boolean] [-mode string] [-pause] [-resume]

backgroundEvaluationManager is NOT undoable, queryable, and NOT editable.

Return value

None

In query mode, return type is based on queried flag.

Keywords

Flags

Long name (short name)	Argument types	Properties
-interrupt(-i)	boolean
Enable or disable fast interrupt of background execution during interactive workflow.
-mode(-m)	string
Changes the current evaluation mode in the evaluation manager. Supported values are "serial" and "parallel".
-pause(-p)
Pause background evaluation. Will block till background evaluation is fully stopped. Can be queried to get the current state.
-resume(-r)
Resume background evaluation. Will start suspended evaluations unless someones else requested it.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Set background evaluation manager to serial mode
backgroundEvaluationManager -mode "serial";
// Result: 1 //

// Return the current background evaluation manager mode
backgroundEvaluationManager -q -m;
// Result: serial //

// Pause background evaluation
backgroundEvaluationManager -pause;
// Result: 1 //

// Return the current background evaluation pause status
backgroundEvaluationManager -q -p;
// Result: 1 //

// Resume background evaluation (unless was paused by someone else)
backgroundEvaluationManager -resume;
// Result: 1 //

// Enable fast interrupt of background executions
backgroundEvaluationManager -interrupt 1;
// Result: 1 //