CScheduledTask Class: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
|style="width: 240px;" | |style="width: 240px;"|[[CScheduledTask.GetPools_Method|GetPools]]||{{:CScheduledTask.GetPools_Method}} | ||
|[[CScheduledTask.GetPools_Method|GetPools]]||{{:CScheduledTask.GetPools_Method}} | |||
|- | |- | ||
|[[CScheduledTask.SetPools_Method|SetPools]]||{{:CScheduledTask.SetPools_Method}} | |[[CScheduledTask.SetPools_Method|SetPools]]||{{:CScheduledTask.SetPools_Method}} | ||
| Line 35: | Line 31: | ||
|- | |- | ||
|Condition||Gets or sets a description of the condition that indicates that a failure will occur (for reliability centered maintenance analysis), such as a threshold for a measurement of wear, vibration, etc. '''String'''. | |Condition||Gets or sets a description of the condition that indicates that a failure will occur (for reliability centered maintenance analysis), such as a threshold for a measurement of wear, vibration, etc. '''String'''. | ||
|- | |- | ||
|DurationModelID||Gets or sets the numeric ID of the model that represents the duration of the task. '''Integer''' | |DurationModelID||Gets or sets the numeric ID of the model that represents the duration of the task. '''Integer''' | ||
| Line 63: | Line 57: | ||
|- | |- | ||
|OnCondBringSystemDown||Indicates whether the task brings the system down. Applies to on condition tasks upon detection. '''Boolean'''. Default value = False. | |OnCondBringSystemDown||Indicates whether the task brings the system down. Applies to on condition tasks upon detection. '''Boolean'''. Default value = False. | ||
|- | |- | ||
|OnCondDurationModelID||Gets or sets the numeric ID of the model that represents the duration of the task. Applies to on condition tasks upon detection. '''Integer'''. | |OnCondDurationModelID||Gets or sets the numeric ID of the model that represents the duration of the task. Applies to on condition tasks upon detection. '''Integer'''. | ||
Revision as of 17:00, 12 March 2019
 |
Member of: SynthesisAPI
Represents a scheduled task resource. The task may be a preventive maintenance, inspection or on condition task.
Constructors
| Name | Description |
|---|---|
| cScheduledTask | Creates an instance of the cSheduledTask class. |
| cScheduledTask() | A parameterized constructor for the cScheduledTask class. (.NET only) |
Methods
| Name | Description |
|---|---|
| GetPools | Returns an array of the Pool IDs and number of parts for all pools required for the task. |
| SetPools | Sets the Pool IDs and number of parts for all pools required for the task. |
Properties
| Name | Description |
|---|---|
| BringItemDown | Indicates whether the task brings the item down. Boolean. Default value = True. |
| BringSystemDown | Indicates whether the task brings the system down. Boolean. Default value = False. |
| Condition | Gets or sets a description of the condition that indicates that a failure will occur (for reliability centered maintenance analysis), such as a threshold for a measurement of wear, vibration, etc. String. |
| DurationModelID | Gets or sets the numeric ID of the model that represents the duration of the task. Integer |
| GroupIDs() | Gets an array containing the numeric IDs of the selected maintenance groups when the task is performed based on maintenance groups. (.NET only) Long. |
| ID | Gets the numeric ID of the task. Integer. |
| Intervals() | Gets or sets an array containing the interval start values when the task is performed based on dynamic intervals. Double. |
| ItemApplication | Gets or sets the item's application. (Synthesis identifier) String |
| ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
| ItemComments | Gets or sets the comments. (Synthesis identifier) String |
| ItemDescription | Gets or sets the description. (Synthesis identifier) String |
| ItemKeywords | Gets or sets the keywords. (Synthesis identifier) String |
| ItemPartNumber | Gets or sets the part number. (Synthesis identifier) String |
| ItemSupplier | Gets or sets the supplier name. (Synthesis identifier) String |
| ItemVersion | Gets or sets the version number. (Synthesis identifier) String |
| MaintenanceTriggers | Gets or sets the value of the maintenance trigger assigned to the task. Integer. Can be any value from the TaskMaintenanceTriggerEnum enumeration or the sum of any combination of values from the enumeration (this allows you to get or set more than one trigger). Default value = 0 (no triggers) |
| MiscCostModelID | Gets or sets the numeric ID of the model that represents the task's cost per task. Applies to preventive and inspection tasks. Integer. |
| MiscCostPerTimeModelID | Gets or sets the numeric ID of the model that represents the task's downtime rate ($/Hr). Applies to preventive and inspection tasks. Integer. |
| Name | Gets or sets the task's name. String. |
| OCMiscCostModelID | Gets or sets the numeric ID of the model that represents the task's cost per task. Applies to on condition tasks upon detection. Integer. |
| OCMiscCostPerTimeModelID | Gets or sets the numeric ID of the model that represents the task's downtime rate($/Hr). Applies to on condition tasks upon detection.Integer. |
| OnCondBringItemDown | Indicates whether the task brings the item down. Applies to on condition tasks upon detection. Boolean. Default value = True. |
| OnCondBringSystemDown | Indicates whether the task brings the system down. Applies to on condition tasks upon detection. Boolean. Default value = False. |
| OnCondDurationModelID | Gets or sets the numeric ID of the model that represents the duration of the task. Applies to on condition tasks upon detection. Integer. |
| OnCondFailureDetectionThreshold | Gets or sets the value for the task's failure detection threshold interval (0.9 = 90% percent of life). Double. Default value = 0.9. |
| OnCondPFInterval | Gets or sets the value for the task's prior-to-failure (P-F) interval. Double. Default value = 100. |
| OnCondPFIntervalUnitID | Gets or sets the numeric ID of the unit of measurement applied to the P-F interval. Integer. |
| OnCondResFactorValue | Gets or sets the on condition task's restoration amount. A value of 1 indicates an "as good as new" condition," a value of 0 indicates an "as bad as old" condition. A value between 0 and 100 indicates partial restoration. Double. Default value = 1. |
| OnCondResFactorType | Gets or set a value from the TaskRestorationTypeEnum enumeration, which specifies the effect of the restoration. Default value = 1 (restores all accumulated damage). |
| OnCondUsePFInterval | Indicates whether the prior-to-failure (P-F) interval should be used to detect imminent failures. Boolean. If true, specify a value for OnCondPFInterval; if false, specify a value for OnCondFailureDetectionThreshold. Default value = False. |
| PackageID | Gets the numeric ID of the task package that will override the task's scheduling properties (0 = no override). Integer. |
| PerformTaskEvenIfItBringsSysDown | Indicates whether the task should be performed if bringing the item down causes the system to go down. Boolean. Default value = True. |
| PerformTaskEvenIfItemAlreadyFailed | Indicates whether the task should be performed even if the item failed before the task was scheduled to occur. Boolean. Default value = False. |
| Pools | Returns the list containing spare pool ID and the number of parts for each pool assigned for the task as a new list of PoolInfo (.NET only). In case of duplicate entries (same pool ID), the latest entry takes preference. |
| ProjectID | Gets the numeric ID of the project the task belongs to. Integer. |
| PropInterval | Gets or sets the interval value that was initially proposed for the task (for reliability centered maintenance analysis). Variant. |
| PropIntervalUnitID | Gets or sets numeric ID for the unit of measurement applied to the proposed interval. Integer. |
| RefDoc | Gets or sets the description for the reference document that provides more detailed information about the task (for reliability centered maintenance analysis). String. |
| ResFactorType | Gets or sets a value from the TaskRestorationTypeEnum enumeration, which specifies the effect of the restoration. Default value = 1 (restores all accumulated damage). |
| ResFactorValue | Gets or sets the scheduled task's restoration amount. A value of 1 indicates an "as good as new" condition," a value of 0 indicates an "as bad as old" condition. A value between 0 and 100 indicates partial restoration. Double. Default value = 1. |
| Status | Gets or sets the status of the task (for reliability centered maintenance analysis). String. |
| TaskAccess | Gets or sets the access that will be required in order to perform the task (typically for aircraft MSG-3 analyses). String. |
| TaskClass | Gets or set one of the values of the TaskClassEnum, which specifies the task's class (e.g., preventive task, inspection or on condition). Default value = 0 (preventive task). |
| TaskFrequencyID | Gets or sets a value from the TaskFrequencyEnum, which specifies the frequency at which the task is performed. Default value = 5 (whenever system is down). |
| TaskFrequencyUnitID | Gets or sets the numeric ID of the unit of measurement of the intervals at which the task is performed. Integer. |
| TaskFrequencyValue | Gets or sets the fixed interval at which the task is performed. Double. Default value = 1. |
| TaskFreqValueVariableID | Gets or sets the numeric ID of the variable that represents the fixed interval at which the task is performed. Integer. |
| TaskTypeID | Gets or sets the numeric ID of the RCM++ or RBI task type (1 = the first task type defined in the repository). Integer. Default value = -1, which indicates no task type is available. |
| TaskZone | Gets or sets the zone of the system in which the task will be performed (aircraft MSG-3 analyses). String. |
| UDD1 | Gets or sets the text in the first user-defined drop-down field. Only applicable to RCM++. (Limited to 50 characters.) String. |
| UDD2 | Gets or sets the text in the second user-defined drop-down field. Only applicable to RCM++. (Limited to 50 characters.) String. |
| UDT1 | Gets or sets the date in the first user-defined date field. Only applicable to RCM++. Variant. |
| UDT2 | Gets or sets the date in the second user-defined date field. Only applicable to RCM++. Variant. |
| UN1 | Gets or sets the value in the first user-defined number field. Only applicable to RCM++. Variant. |
| UN2 | Gets or sets the value in the second user-defined number field. Only applicable to RCM++. Variant. |