TaskFrequencyEnum Enumeration: Difference between revisions

Latest revision as of 21:31, 13 November 2015

Specifies the frequency at which a task is performed.

Name	Value	Description
Never	0	The task is never performed.
ItemAge	1	Fixed time frame based on item's age.
SystemAge	2	Fixed time frame based on calendar time.
DynamicIntervalsOnSystemAge	3	Dynamic intervals based on the item's age.
DynamicIntervalsOnItemAge	4	Dynamic intervals based on calendar time.
SystemDown	5	Whenever the system is down.
GroupMaintenance	6	Based on events in a maintenance group.
MaintenancePhase	7	When a maintenance phase starts.
UponFailure	8	Upon item failure (corrective task).
UponInspection	9	When found failed during an inspection (corrective task).

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Global_Resources|Global_Resources}}
+{{Template:API}}{{Template:APIBreadcrumb}}
-Assign values to TaskFrequency within CorrectiveTasks
-== Syntax==
-{{APIPrefix| Public Enum}}
-{{APIName|'''TaskFrequencyEnum'''}}<br>
+<onlyinclude>Specifies the frequency at which a task is performed. </onlyinclude>
-{{Template:TaskFrequencyEnum}}<br>
-{{APIComment|Can be used to assign values to TaskFrequency within CorrectiveTasks}}
+== Members ==
+{| {{APITableEnum}}
+|-
+|style="width:200px"|Never||style="width:70px"|0||The task is never performed.
+|-
+|ItemAge||style="width:70px"|1||Fixed time frame based on item's age.
+|-
+|SystemAge||2||Fixed time frame based on calendar time.
+|-
+|DynamicIntervalsOnSystemAge||3||Dynamic intervals based on the item's age.
+|-
+|DynamicIntervalsOnItemAge||4||Dynamic intervals based on calendar time.
+|-
+|SystemDown||5||Whenever the system is down.
+|-
+|GroupMaintenance||6||Based on events in a maintenance group.
+|-
+|MaintenancePhase||7||When a maintenance phase starts.
+|-
+|UponFailure||8||Upon item failure (corrective task).
+|-
+|UponInspection||9||When found failed during an inspection (corrective task).
+|}
+==See Also==
+*[[CCorrectiveTask Class|cCorrectiveTask Class]]
+*[[CScheduledTask Class|cScheduledTask Class]]