TaskMaintenanceTriggerEnum Enumeration: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:


<onlyinclude>Specifies which event in the maintenance group(s) triggers the task.</onlyinclude>
<onlyinclude>Specifies which event in the maintenance group(s) triggers the task.</onlyinclude>
Note: In the <code>Maintenance Triggers</code> property of the <code>[[CScheduledTask Class|cScheduledTask class]]</code>, you can set two or more triggers by taking the sum of the value of each trigger or by using a logical "OR." For example, to trigger the task when a corrective (value=2) or preventive (value=4) maintenance starts, you would set the value of the property to 6.


==Members==
==Members==
{| {{APITableEnum}}
{| {{APITableEnum}}
|-
|-
| style="width: 160px;"|BlockFails||style="width: 70px;"|1||The task is performed when a block in the maintenance group fails.
| style="width: 160px;"|NoTriggers||style="width: 70px;"|0||No task is performed.
|-
|BlockFails||1||The task is performed when a block in the maintenance group fails.
|-
|-
|CorrectiveMaintenance||2||The task is performed when a block in the maintenance group starts corrective maintenance.
|CorrectiveMaintenance||2||The task is performed when a block in the maintenance group starts corrective maintenance.
Line 19: Line 19:
|BlockRestored||16||The task is performed when a block in the maintenance group is restored to operation.
|BlockRestored||16||The task is performed when a block in the maintenance group is restored to operation.
|}
|}




Line 26: Line 24:


==See Also==
==See Also==
*[[CScheduledTask Class|cScheduledTask Class]]
*[[CScheduledTask.MaintenanceTriggers|CScheduledTask.MaintenanceTriggers Property]]

Latest revision as of 21:58, 24 June 2016

APIWiki.png


Member of: SynthesisAPI


Specifies which event in the maintenance group(s) triggers the task.

Members

Name Value Description
NoTriggers 0 No task is performed.
BlockFails 1 The task is performed when a block in the maintenance group fails.
CorrectiveMaintenance 2 The task is performed when a block in the maintenance group starts corrective maintenance.
PreventiveMaintenance 4 The task is performed when a block in the maintenance group starts preventive maintenance.
Inspection 8 The task is performed when a block in the maintenance group starts inspection.
BlockRestored 16 The task is performed when a block in the maintenance group is restored to operation.



See Also