smartinspectpython.sischedulercommand

Module: si .py

Revision History

Date Version Description
2023/05/30 3.0.0.0 Initial Version.

@export
class SISchedulerCommand:

Represents a scheduler command as used by the SIScheduler class and the asynchronous protocol mode.

This class is used by the SIScheduler class to enqueue protocol operations for later execution when operating in asynchronous mode. For detailed information about the asynchronous protocol mode, please refer to SIProtocol.IsValidOption.

Threadsafety:

This class is not guaranteed to be thread-safe.

SISchedulerCommand()

Initializes a new instance of the class.

Gets the Action property value.

Represents the scheduler action to execute. Please refer to the documentation of the SISchedulerAction enum for more information about possible values.

Size: int

Gets the Size property value.

Calculates and returns the total memory size occupied by this scheduler command.

This read-only property returns the total occupied memory size of this scheduler command. This functionality is used by the SIProtocol.IsValidOption to track the total size of scheduler commands.

State: object

Gets the State property value.

Represents the optional scheduler command state object which provides additional information about the scheduler command. This property can be null.