Skip to content

ModifiableStatusParam

Bases: ParentStatusParam

ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution.

This class serves as a status parameter where the value is associated with a specific index, allowing for indexed modifications during a sequence execution.

__init__(*args)

Overload 1:

Copy constructor.

Parameters:

Name Type Description Default
other ModifiableStatusParam

The ModifiableStatusParam to copy | Overload 2: Constructor without value.

required
subDeviceId SubDeviceId

The sub-device ID of the associated sub-device

required
modifIndex int

The modifiable parameter identifier | Overload 3: Constructor from string value.

required
value string

The string value | Overload 4: Constructor from char value.

required

clone()

Clone object.

Creates a deep copy.

Returns:

Type Description
StatusParam

The copy

equals(other)

Check equality.

Compares this instance with another for equality. Test if the modifiable parameter identifiers are equal.

Parameters:

Name Type Description Default
other StatusParam

The status param to compare with

required

Returns:

Type Description
boolean

True if equal, false otherwise