CScheduledTask Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 29: | Line 29: | ||
|- | |- | ||
|BringItemDown||Indicates whether the task brings | |BringItemDown||Indicates whether the task brings the item down. '''Boolean''' | ||
|- | |- | ||
|BringSystemDown||Indicates whether the task brings | |BringSystemDown||Indicates whether the task brings the system down. '''Boolean''' | ||
|- | |- | ||
|Condition||Gets or sets the condition that indicates that a failure will occur. '''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'''. | ||
|- | |- | ||
|CrewIDs||Gets the IDs of the crews assigned to the task. ''' | |CrewIDs()||Gets or sets an array containing the numeric IDs of the crews assigned to the task. '''Long''' | ||
|- | |- | ||
|DiagramIDs||Gets an array containing the numeric IDs of the diagrams the task is assigned to. ''' | |DiagramIDs()||Gets an array containing the numeric IDs of the diagrams the task is assigned to. '''Long'''. | ||
|- | |- | ||
|DurationModelID||Gets the ID of the model that | |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 selected maintenance groups when task | |GroupIDs()||Gets an array containing the numeric IDs of the selected maintenance groups when the task is performed based on maintenance groups. '''Long'''. | ||
|- | |- | ||
|Intervals||Gets an array containing the interval start values when the task is performed based on dynamic intervals. '''Double'''. | |Intervals()||Gets or sets an array containing the interval start values when the task is performed based on dynamic intervals. '''Double'''. | ||
|- | |- | ||
|{{Template:API_TxtIdentifiers}} | |{{Template:API_TxtIdentifiers}} | ||
|- | |- | ||
|MaintenanceTriggers||Gets the value of the maintenance trigger assigned to the task. '''Integer'''. | |MaintenanceTriggers||Gets or sets the value of the maintenance trigger assigned to the task. '''Integer'''. | ||
|- | |- | ||
|MiscCostModelID||Gets the | |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 the | |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'''. | |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'''. | ||
|- | |- | ||
|OnCondDurationModelID||Gets the ID of the model that | |OnCondBringSystemDown||Indicates whether the task brings the system down. Applies to on condition tasks upon detection. '''Boolean''' | ||
|- | |||
|OnCondCrewIDs()||Gets or sets an array containing the numeric IDs of the crews assigned to the task. Applies to on condition tasks upon detection. '''Long'''. | |||
|- | |||
|OnCondDurationModelID||Gets 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'''. | |OnCondFailureDetectionThreshold||Gets or sets the value for the task's failure detection threshold interval (0.9 = 90% percent of life. '''Double'''. |
Revision as of 23:14, 5 October 2015
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 |
---|---|
SetCrewIDs | Version 10 Only - Sets the crew IDs. Designed for VB6/VBA users. .NET users should use CrewIDs property instead. Returns the 0 based array of IDs. Integer. |
GetCrewIDs | Version 10 Only - Gets an array of the crew IDs. Designed for VB6/VBA users. .NET users should use CrewIDs property instead. Returns the 0 based array of
IDs. Integer. |
Properties
Name | Description |
---|---|
BringItemDown | Indicates whether the task brings the item down. Boolean |
BringSystemDown | Indicates whether the task brings the system down. Boolean |
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. |
CrewIDs() | Gets or sets an array containing the numeric IDs of the crews assigned to the task. Long |
DiagramIDs() | Gets an array containing the numeric IDs of the diagrams the task is assigned to. Long. |
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. Long. |
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. |
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. |
OnCondBringSystemDown | Indicates whether the task brings the system down. Applies to on condition tasks upon detection. Boolean |
OnCondCrewIDs() | Gets or sets an array containing the numeric IDs of the crews assigned to the task. Applies to on condition tasks upon detection. Long. |
OnCondDurationModelID | Gets 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. |
OnCondPerformTaskEvenIfItBringsSysDown | Indicates whether the task should be performed if bringing the item down causes the system to go down. Boolean |
OnCondPerformTaskEvenIfItemAlreadyFailed | Indicates whether the task should be performed if it has already failed. Boolean |
OnCondPFInterval | Gets or sets the value for the task's prior to failure interval. Double. |
OnCondPFIntervalUnitID | Gets or sets the numerical ID for the units of measurement applied to the prior to failure interval. Integer. |
OnCondPoolID | Gets the IDs of the pool assigned to the task. Integer. |
OnCondResFactorValue | Gets or sets the corrective task's restoration Amount (0.9 = 90% restoration). Double. |
OnCondResFactorType | Gets or set a value from the TaskRestorationTypeEnum enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair). |
OnCondUsePFInterval | Indicates whether the prior to failure interval should be used. Boolean |
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 |
PerformTaskEvenIfItemAlreadyFailed | Indicates whether the task should be performed if it has already failed. Boolean |
PoolID | Gets the IDs of the pool assigned to the task. Integer. |
PropInterval | Gets or sets the task's proposed interval value. Object. |
PropIntervalUnitID | Gets or sets numeric ID for the units of measurement applied to the proposed interval. Integer. |
RefDoc | Gets or sets the reference document that provides more detailed information about the task. String. |
ResFactorType | Gets or sets a value from the TaskRestorationTypeEnum enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair). |
ResFactorValue | Gets or sets the corrective task's Restoration Amount (0.9 = 90% restoration). Double. |
Status | Gets or sets the status of the task. String. |
TaskAccess | Gets or sets the access that will be required in order to perform the task. 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). |
TaskFrequencyUnitID | Gets the numeric ID for the current units of measurement of the intervals at which the task is performed. Integer. |
TaskFrequencyValue | Gets or sets the current fixed interval when the task is performed based on item age. Double. |
TaskFreqValueVariableID | Gets the numeric ID of the variable that currently represents the fixed interval when the task is performed based on item age. Integer. |
TaskTypeID | Gets or sets the numeric ID of the task's class. Integer. |
TaskZone | Gets or sets the zone in which the task will be performed. String. |
UDD1 | Gets or sets the Task User Drop-Down 1. (Limited to 50 characters.) String. |
UDD2 | Gets or sets the Task User Drop-Down 2. (Limited to 50 characters.) String. |
UDT1 | Gets or sets the Task User Date 1. Object. |
UDT2 | Gets or sets the Task User Date 2. Object. |
UN1 | Gets or sets the Task User Number 1. Object. |
UN2 | Gets or sets the Task User Number 2. Object. |
TaskFrequencyIDOrig | Deprecated Gets a value from the TaskFrequencyEnum, which specifies the frequency with which a task is performed. |
TaskFrequencyUnitIDOrig | Deprecated Gets the numeric ID for the original units of measurement of the intervals at which the task is performed. Integer. |
TaskFrequencyValueOrig | Deprecated Gets or sets the original fixed interval when the task is performed based on item age. Double. |
TaskFreqValueVariableIDOrig | Deprecated Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. Integer. |