core.ua_enums.SkillState

class documentation

class SkillState(Enum):

Represents the state of a skill (BaseSkill).

State values according to the skill node-set specification.

Constant	`COMPLETED`	State indicating that the skill is completed. Only used for finite skills, because continuous skills do not complete.
Constant	`COMPLETING`	Intermediate state leading to `SkillState.COMPLETED` on success or `SkillState.HALTING` on failure. Only used for finite skills, because continuous skills do not complete.
Constant	`HALTED`	State indicating that the skill is halted (=stopped). To leave this state, the skill needs to be reset. Note: Skills can halt for various reasons, e.g. internal failures, external safety trigger, etc.
Constant	`HALTING`	Intermediate state always leading to `SkillState.HALTED`.
Constant	`READY`	State indicating that the skill is ready to be started.
Constant	`RESETTING`	Intermediate state leading to `SkillState.READY` on success or `SkillState.HALTING` on failure.
Constant	`RUNNING`	State indicating that the skill is running.
Constant	`STARTING`	Intermediate state leading to `SkillState.RUNNING` on success or `SkillState.HALTING` on failure.
Constant	`SUSPENDED`	State indicating that the skill is suspended.
Constant	`SUSPENDING`	Intermediate state leading to `SkillState.SUSPENDING` on success or `SkillState.HALTING` on failure.
Property	`id`	Return the state ID number of the enum member.
Property	`localized_text`	Return the OPC UA localized text of the enum member.

COMPLETED: tuple = ¶

State indicating that the skill is completed. Only used for finite skills, because continuous skills do not complete.

Value

(15, 'Completed')

COMPLETING: tuple = ¶

Intermediate state leading to SkillState.COMPLETED on success or SkillState.HALTING on failure. Only used for finite skills, because continuous skills do not complete.

Value

(18, 'Completing')

HALTED: tuple = ¶

State indicating that the skill is halted (=stopped). To leave this state, the skill needs to be reset. Note: Skills can halt for various reasons, e.g. internal failures, external safety trigger, etc.

Value

(11, 'Halted')

HALTING: tuple = ¶

Intermediate state always leading to SkillState.HALTED.

Value

(17, 'Halting')

READY: tuple = ¶

State indicating that the skill is ready to be started.

Value

(12, 'Ready')

RESETTING: tuple = ¶

Intermediate state leading to SkillState.READY on success or SkillState.HALTING on failure.

Value

(19, 'Resetting')

RUNNING: tuple = ¶

State indicating that the skill is running.

Value

(13, 'Running')

STARTING: tuple = ¶

Intermediate state leading to SkillState.RUNNING on success or SkillState.HALTING on failure.

Value

(16, 'Starting')

SUSPENDED: tuple = ¶

State indicating that the skill is suspended.

Value

(14, 'Suspended')

SUSPENDING: tuple = ¶

Intermediate state leading to SkillState.SUSPENDING on success or SkillState.HALTING on failure.

Value

(20, 'Suspending')

@property

id: int = ¶

Return the state ID number of the enum member.

@property

localized_text: ua.LocalizedText = ¶

Return the OPC UA localized text of the enum member.