trigger ¶

The trigger commands module.

These commands are used in the following models: MSMU60_2

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions

- trigger.model.abort()
- trigger.model.addblock.branch.always()
- trigger.model.addblock.branch.counter()
- trigger.model.addblock.branch.once()
- trigger.model.addblock.branch.onceexcluded()
- trigger.model.addblock.configlist.next()
- trigger.model.addblock.configlist.prev()
- trigger.model.addblock.configlist.recall()
- trigger.model.addblock.delay.constant()
- trigger.model.addblock.logevent()
- trigger.model.addblock.measure()
- trigger.model.addblock.measureoverlapped()
- trigger.model.addblock.nop()
- trigger.model.addblock.reset.branch.counter()
- trigger.model.addblock.source.action.bias()
- trigger.model.addblock.source.action.skip()
- trigger.model.addblock.source.action.step()
- trigger.model.addblock.source.output()
- trigger.model.addblock.wait()
- trigger.model.create()
- trigger.model.delete()
- trigger.model.initiate()
- trigger.model.removeblock()
- trigger.model.state()

Trigger ¶

Bases: BaseTSPCmd

The trigger command tree.

Properties and methods

.model: The trigger.model command tree.

model `property` ¶

model: TriggerModel

Return the trigger.model command tree.

Sub-properties and sub-methods

.abort(): The trigger.model.abort() function.
.addblock: The trigger.model.addblock command tree.
.create(): The trigger.model.create() function.
.delete(): The trigger.model.delete() function.
.initiate(): The trigger.model.initiate() function.
.removeblock(): The trigger.model.removeblock() function.
.state(): The trigger.model.state() function.

TriggerModel ¶

Bases: BaseTSPCmd

The trigger.model command tree.

Properties and methods

.abort(): The trigger.model.abort() function.
.addblock: The trigger.model.addblock command tree.
.create(): The trigger.model.create() function.
.delete(): The trigger.model.delete() function.
.initiate(): The trigger.model.initiate() function.
.removeblock(): The trigger.model.removeblock() function.
.state(): The trigger.model.state() function.

addblock `property` ¶

addblock: TriggerModelAddblock

Return the trigger.model.addblock command tree.

Sub-properties and sub-methods

.branch: The trigger.model.addblock.branch command tree.
.configlist: The trigger.model.addblock.configlist command tree.
.delay: The trigger.model.addblock.delay command tree.
.logevent(): The trigger.model.addblock.logevent() function.
.measure(): The trigger.model.addblock.measure() function.
.measureoverlapped(): The trigger.model.addblock.measureoverlapped() function.
.nop(): The trigger.model.addblock.nop() function.
.reset: The trigger.model.addblock.reset command tree.
.source: The trigger.model.addblock.source command tree.
.wait(): The trigger.model.addblock.wait() function.

abort ¶

abort(trigger_model_name: str) -> None

Run the trigger.model.abort() function.

Description

This function stops trigger model execution on the specified module.

TSP Syntax

- trigger.model.abort()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to abort.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

create ¶

create(trigger_model_name: str) -> None

Run the trigger.model.create() function.

Description

This function creates a trigger model.

TSP Syntax

- trigger.model.create()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to create.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

delete ¶

delete(trigger_model_name: str) -> None

Run the trigger.model.delete() function.

Description

This function deletes a trigger model.

TSP Syntax

- trigger.model.delete()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to delete.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

initiate ¶

initiate(trigger_model_name: str) -> None

Run the trigger.model.initiate() function.

Description

This function starts a specified trigger model on a module.

TSP Syntax

- trigger.model.initiate()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to start.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

removeblock ¶

removeblock(trigger_model_name: str, trigger_block_name: str) -> None

Run the trigger.model.removeblock() function.

Description

This function removes the trigger block from the trigger model.

TSP Syntax

- trigger.model.removeblock()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model from which this trigger block will be removed. `trigger_block_name` (`str`) – Unique name of the trigger block to remove; this string cannot be empty.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

state ¶

state(trigger_model_name: str) -> str

Run the trigger.model.state() function.

Description

This function returns the present state of the trigger model.

TSP Syntax

- trigger.model.state()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblock ¶

Bases: BaseTSPCmd

The trigger.model.addblock command tree.

Properties and methods

.branch: The trigger.model.addblock.branch command tree.
.configlist: The trigger.model.addblock.configlist command tree.
.delay: The trigger.model.addblock.delay command tree.
.logevent(): The trigger.model.addblock.logevent() function.
.measure(): The trigger.model.addblock.measure() function.
.measureoverlapped(): The trigger.model.addblock.measureoverlapped() function.
.nop(): The trigger.model.addblock.nop() function.
.reset: The trigger.model.addblock.reset command tree.
.source: The trigger.model.addblock.source command tree.
.wait(): The trigger.model.addblock.wait() function.

branch `property` ¶

branch: TriggerModelAddblockBranch

Return the trigger.model.addblock.branch command tree.

Sub-properties and sub-methods

.always(): The trigger.model.addblock.branch.always() function.
.counter(): The trigger.model.addblock.branch.counter() function.
.once(): The trigger.model.addblock.branch.once() function.
.onceexcluded(): The trigger.model.addblock.branch.onceexcluded() function.

configlist `property` ¶

configlist: TriggerModelAddblockConfiglist

Return the trigger.model.addblock.configlist command tree.

Sub-properties and sub-methods

.next(): The trigger.model.addblock.configlist.next() function.
.prev(): The trigger.model.addblock.configlist.prev() function.
.recall(): The trigger.model.addblock.configlist.recall() function.

delay `property` ¶

delay: TriggerModelAddblockDelay

Return the trigger.model.addblock.delay command tree.

Sub-properties and sub-methods

.constant(): The trigger.model.addblock.delay.constant() function.

reset `property` ¶

reset: TriggerModelAddblockReset

Return the trigger.model.addblock.reset command tree.

Sub-properties and sub-methods

.branch: The trigger.model.addblock.reset.branch command tree.

source `property` ¶

source: TriggerModelAddblockSource

Return the trigger.model.addblock.source command tree.

Sub-properties and sub-methods

.action: The trigger.model.addblock.source.action command tree.
.output(): The trigger.model.addblock.source.output() function.

logevent ¶

logevent(trigger_model_name: str, block_name: str, event_number: int, message: str) -> None

Run the trigger.model.addblock.logevent() function.

Description

This function allows you to log an event in the event log when the trigger model is running.

TSP Syntax

- trigger.model.addblock.logevent()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `event_number` (`int`) – The event number. `message` (`str`) – A string up to 31 characters.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

measure ¶

measure(trigger_model_name: str, block_name: str, channel: str, count: str | None = None) -> None

Run the trigger.model.addblock.measure() function.

Description

This function defines a trigger block that makes a measurement.

TSP Syntax

- trigger.model.addblock.measure()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the trigger block. `channel` (`str`) – Channel list, specified in a table; for example. `count` (`optional`, default: `None` ) – Number of measurements to make when this block is executed.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

measureoverlapped ¶

measureoverlapped(
    trigger_model_name: str, block_name: str, channel: str, count: str | None = None
) -> None

Run the trigger.model.addblock.measureoverlapped() function.

Description

This function defines a trigger model block that makes a measurement in an overlapped mode which allows you to measure the response of the device under test while the source is being stepped.

TSP Syntax

- trigger.model.addblock.measureoverlapped()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the trigger block. `channel` (`str`) – Module channel number to measure. `count` (`optional`, default: `None` ) – Number of measurements to make when this block starts.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

nop ¶

nop(trigger_model_name: str, block_name: str) -> None

Run the trigger.model.addblock.nop() function.

Description

This function creates a placeholder block that performs no action in the trigger model.

TSP Syntax

- trigger.model.addblock.nop()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the trigger block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(
    trigger_model_name: str,
    block_name: str,
    event: str,
    clear: str | None = None,
    logic: str | None = None,
    event_2: str | None = None,
    event_3: str | None = None,
    event_4: str | None = None,
) -> None

Run the trigger.model.addblock.wait() function.

Description

This function defines a trigger model block that waits for an event before allowing the trigger model to continue.

TSP Syntax

- trigger.model.addblock.wait()

Parameters:

trigger_model_name (str) –

Name of the trigger model to which the block will be added.
block_name (str) –

Name of the trigger block being added by this command.
event (str) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).
clear (optional, default: None ) –

To clear previously detected trigger events when entering the wait block.
logic (optional, default: None ) –

If each event must occur before the trigger model continues.
event_2 (optional, default: None ) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).
event_3 (optional, default: None ) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).
event_4 (optional, default: None ) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockBranch ¶

Bases: BaseTSPCmd

The trigger.model.addblock.branch command tree.

Properties and methods

.always(): The trigger.model.addblock.branch.always() function.
.counter(): The trigger.model.addblock.branch.counter() function.
.once(): The trigger.model.addblock.branch.once() function.
.onceexcluded(): The trigger.model.addblock.branch.onceexcluded() function.

always ¶

always(trigger_model_name: str, block_name: str, branch_to_block_name: str) -> None

Run the trigger.model.addblock.branch.always() function.

Description

This function defines a trigger model block that always branches to a specific block.

TSP Syntax

- trigger.model.addblock.branch.always()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `branch_to_block_name` (`str`) – Name of the next trigger block to run.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

counter ¶

counter(
    trigger_model_name: str, block_name: str, branch_to_block_name: str, target_count: str
) -> None

Run the trigger.model.addblock.branch.counter() function.

Description

This function defines a trigger model block that branches to a block a specified number of times.

TSP Syntax

- trigger.model.addblock.branch.counter()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `branch_to_block_name` (`str`) – Name of the next block to run. `target_count` (`str`) – Number of times to repeat the branch.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

once ¶

once(trigger_model_name: str, block_name: str, branch_to_block_name: str) -> None

Run the trigger.model.addblock.branch.once() function.

Description

This function causes the trigger model to branch to a specified trigger model block the first time it is encountered in the trigger model.

TSP Syntax

- trigger.model.addblock.branch.once()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block is added. `block_name` (`str`) – Name of the trigger block. `branch_to_block_name` (`str`) – Name of the block to branch to on the first pass through this block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

onceexcluded ¶

onceexcluded(trigger_model_name: str, block_name: str, branch_to_block_name: str) -> None

Run the trigger.model.addblock.branch.onceexcluded() function.

Description

This function causes the trigger model to branch to a specified trigger model block every time it is encountered in the trigger model except for the first time.

TSP Syntax

- trigger.model.addblock.branch.onceexcluded()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block is added. `block_name` (`str`) – Name of the trigger block. `branch_to_block_name` (`str`) – Name of the block to branch to on the first pass through this block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockConfiglist ¶

Bases: BaseTSPCmd

The trigger.model.addblock.configlist command tree.

Properties and methods

.next(): The trigger.model.addblock.configlist.next() function.
.prev(): The trigger.model.addblock.configlist.prev() function.
.recall(): The trigger.model.addblock.configlist.recall() function.

next ¶

next(trigger_model_name: str, block_name: str, channel: str, configlist_name: str) -> None

Run the trigger.model.addblock.configlist.next() function.

Description

This function recalls the settings at the next index of a configuration list.

TSP Syntax

- trigger.model.addblock.configlist.next()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `channel` (`str`) – Module channel number. `configlist_name` (`str`) – A string that defines the configuration list to recall.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

prev ¶

prev(trigger_model_name: str, block_name: str, channel: str, configlist_name: str) -> None

Run the trigger.model.addblock.configlist.prev() function.

Description

This function defines a trigger model block that recalls the settings stored at the previous index in a configuration list.

TSP Syntax

- trigger.model.addblock.configlist.prev()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `channel` (`str`) – Module channel number. `configlist_name` (`str`) – A string that defines the configuration list to recall.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

recall ¶

recall(
    trigger_model_name: str, block_name: str, channel: str, configlist_name: str, index: int
) -> None

Run the trigger.model.addblock.configlist.recall() function.

Description

This function recalls the system settings that are stored in a configuration list.

TSP Syntax

- trigger.model.addblock.configlist.recall()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `channel` (`str`) – Module channel number. `configlist_name` (`str`) – A string that defines the configuration list to recall. `index` (`int`) – The index in the configuration list to recall; default is 1.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockDelay ¶

Bases: BaseTSPCmd

The trigger.model.addblock.delay command tree.

Properties and methods

.constant(): The trigger.model.addblock.delay.constant() function.

constant ¶

constant(
    trigger_model_name: str,
    block_name: str,
    delay_time: str | None = None,
    reference_block_name: str | None = None,
) -> None

Run the trigger.model.addblock.delay.constant() function.

Description

This function adds a constant delay to the execution of a trigger model.

TSP Syntax

- trigger.model.addblock.delay.constant()

Parameters:

trigger_model_name (str) –

Name of the trigger model to which the block will be added.
block_name (str) –

Name of the trigger block where execution will proceed when the evaluation result is true.
delay_time (optional, default: None ) –

Time delay as a positive value.
reference_block_name (optional, default: None ) –

Trigger model block to use for the start time of the delay; see Details.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockReset ¶

Bases: BaseTSPCmd

The trigger.model.addblock.reset command tree.

Properties and methods

.branch: The trigger.model.addblock.reset.branch command tree.

branch `property` ¶

branch: TriggerModelAddblockResetBranch

Return the trigger.model.addblock.reset.branch command tree.

Sub-properties and sub-methods

.counter(): The trigger.model.addblock.reset.branch.counter() function.

TriggerModelAddblockResetBranch ¶

Bases: BaseTSPCmd

The trigger.model.addblock.reset.branch command tree.

Properties and methods

.counter(): The trigger.model.addblock.reset.branch.counter() function.

counter ¶

counter(trigger_model_name: str, block_name: str, reset_branch_count_block_name: str) -> None

Run the trigger.model.addblock.reset.branch.counter() function.

Description

This function defines a trigger model block that resets the count for a branch counter block.

TSP Syntax

- trigger.model.addblock.reset.branch.counter()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the block to be added. `reset_branch_count_block_name` (`str`) – Name of the branch counter block to reset the count value to 0.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockSource ¶

Bases: BaseTSPCmd

The trigger.model.addblock.source command tree.

Properties and methods

.action: The trigger.model.addblock.source.action command tree.
.output(): The trigger.model.addblock.source.output() function.

action `property` ¶

action: TriggerModelAddblockSourceAction

Return the trigger.model.addblock.source.action command tree.

Sub-properties and sub-methods

.bias(): The trigger.model.addblock.source.action.bias() function.
.skip(): The trigger.model.addblock.source.action.skip() function.
.step(): The trigger.model.addblock.source.action.step() function.

output ¶

output(trigger_model_name: str, block_name: str, channel: str, state: str) -> None

Run the trigger.model.addblock.source.output() function.

Description

This function defines a trigger model block that turns the output source on or off.

TSP Syntax

- trigger.model.addblock.source.output()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block will be added. `block_name` (`str`) – Name of the trigger block to be added. `channel` (`str`) – Module channel number. `state` (`str`) – Turn the source off.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModelAddblockSourceAction ¶

Bases: BaseTSPCmd

The trigger.model.addblock.source.action command tree.

Properties and methods

.bias(): The trigger.model.addblock.source.action.bias() function.
.skip(): The trigger.model.addblock.source.action.skip() function.
.step(): The trigger.model.addblock.source.action.step() function.

bias ¶

bias(trigger_model_name: str, block_name: str, channel: str) -> None

Run the trigger.model.addblock.source.action.bias() function.

Description

This function creates a block that sets the source output level to the bias level.

TSP Syntax

- trigger.model.addblock.source.action.bias()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which this block is added. `block_name` (`str`) – Name of the trigger block. `channel` (`str`) – Channel number.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

skip ¶

skip(trigger_model_name: str, block_name: str, channel: str) -> None

Run the trigger.model.addblock.source.action.skip() function.

Description

This function defines a trigger model block that skips a step in the sweep operation on the specified channel.

TSP Syntax

- trigger.model.addblock.source.action.skip()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block is added. `block_name` (`str`) – Name of the trigger block defining where to branch. `channel` (`str`) – Channel number.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

step ¶

step(trigger_model_name: str, block_name: str, channel: str) -> None

Run the trigger.model.addblock.source.action.step() function.

Description

This function defines a trigger model block that advances the source output to the next point of the sweep for the specified channel.

TSP Syntax

- trigger.model.addblock.source.action.step()

Parameters:	`trigger_model_name` (`str`) – Name of the trigger model to which the block is added. `block_name` (`str`) – Name of the trigger block defining where to branch. `channel` (`str`) – Channel number.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

trigger ¶

Trigger ¶

model property ¶

TriggerModel ¶

addblock property ¶

abort ¶

create ¶

delete ¶

initiate ¶

removeblock ¶

state ¶

TriggerModelAddblock ¶

branch property ¶

configlist property ¶

delay property ¶

reset property ¶

source property ¶

logevent ¶

measure ¶

measureoverlapped ¶

nop ¶

wait ¶

TriggerModelAddblockBranch ¶

always ¶

counter ¶

once ¶

onceexcluded ¶

TriggerModelAddblockConfiglist ¶

next ¶

prev ¶

recall ¶

TriggerModelAddblockDelay ¶

constant ¶

TriggerModelAddblockReset ¶

branch property ¶

TriggerModelAddblockResetBranch ¶

counter ¶

TriggerModelAddblockSource ¶

action property ¶

output ¶

TriggerModelAddblockSourceAction ¶

bias ¶

skip ¶

step ¶

model `property` ¶

addblock `property` ¶

branch `property` ¶

configlist `property` ¶

delay `property` ¶

reset `property` ¶

source `property` ¶

branch `property` ¶

action `property` ¶