TaskMaintenanceTriggerEnum Enumeration: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
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.
|}
|}
'''Notes:'''
The <code>Maintenance Triggers</code> property of the <code>[[CScheduledTask Class|cScheduledTask class]]</code> allows you to get or set more than one trigger by taking the sum of the values of the events. For example, a property value of 6 indicates that the task is triggered when a corrective maintenance (value=2) or preventive maintenance (value=4) starts.
Alternatively, you can set a combination of triggers by using the logical <code>Or</code> operator. For example, the following VB.NET code sets two triggers:
  {{APIPrefix|Dim}} t {{APIPrefix|As New}} cScheduledTask 
  {{APIComment|'Set the property}}
  t.MaintenanceTriggers = TaskMaintenanceTriggerEnum.BlockFails {{APIPrefix|Or}} TaskMaintenanceTriggerEnum.BlockRestored




Line 35: 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