Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeStopAllJobs

maeStopAllJobs(
[ ?session t_sessionName ]
[ ?jobType t_jobType ]
[ ?force g_force ]
[ ?exitCode t_exitCode ]
)
=> t / nil

Description

Stops all the simulation or netlisting jobs you started during the current session regardless of their state (started, getting configured, running).

Arguments

?session t_sessionName

Stops the jobs associated with the specified session.

When not specified, the jobs associated with the current session are stopped.

?jobType t_jobType

The type of the job to be stopped.

Possible values:

  • "simulation"
  • "netlisting"

When no value is specified, both types of jobs are stopped.

?force g_force

If set to t, kills the job by sending a signal, such as SIGKILL. Otherwise, it kills the job by using an internal communication mechanism.

?exitCode t_exitCode

Sets the specified exit code for the stopped jobs.

This argument can be used only when the ?force argument is set to nil.

Value Returned

t

The simulation or netlisting jobs you started during the current session are stopped regardless of their state.

nil

Indicates that the specified session or job type is invalid.

Examples

Stops all the jobs for the current session.

maeStopAllJobs()
=>t

Stops all netlister service jobs for the current session.

maeStopAllJobs("netlisting")
=>t

Stops all jobs by sending a SIGKILL signal.

maeStopAllJobs(?force t)
=>t

Stops all jobs and returns the exit code 4.

maeStopAllJobs(?exitCode 4)
=>t

Return to top
 ⠀
X