CScheduledTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 26: Line 26:
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 240px;"|Name||Gets or sets the task's name. '''String'''.
| style="width: 240px;"|
 
|-
|BringItemDown||Indicates whether the task brings an item down. '''Boolean'''
|-
|BringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
|-
|-
|TaskClass||Gets or set one of the values of the '''[[TaskClassEnum Enumeration|TaskClassEnum]]''', which specifies the task's class (e.g., preventive task, inspection or on condition).
|Condition||Gets or sets the condition that indicates that a failure will occur. '''String'''.
|-
|-
|TaskTypeID||Gets or sets the numeric ID of the task's class. '''Integer'''.
|CrewIDs||Gets the IDs of the crews assigned to the task. '''Integer'''
|-
|-
|DiagramIDs||Gets an array containing the numeric IDs of the diagrams the task is assigned to.  '''Integer'''.
|DiagramIDs||Gets an array containing the numeric IDs of the diagrams the task is assigned to.  '''Integer'''.
|}
'''Task Scheduling'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|TaskFrequencyUnitID||Gets the numeric ID for the current units of measurement of the intervals at which the task is performed. '''Integer'''.
|DurationModelID||Gets the ID of the model that describes the duration of the task. '''Integer'''
|-
|-
|TaskFrequencyValue||Gets or sets the current fixed interval when the task is performed based on item age. '''Double'''.
|GroupIDs||Gets an array containing the numeric IDs of selected maintenance groups when task performance is based on maintenance groups. '''Integer'''.
|-
|TaskFreqValueVariableID||Gets the numeric ID of the variable that currently represents the fixed interval when the task is performed based on item age. '''Integer'''.
|-
|-
|Intervals||Gets an array containing the interval start values when the task is performed based on dynamic intervals. '''Double'''.
|Intervals||Gets an array containing the interval start values when the task is performed based on dynamic intervals. '''Double'''.
|-
|-
|PackageID||Gets the numeric ID of the task package that will override the task's scheduling properties (0 = no override).  '''Integer'''.
|{{Template:API_TxtIdentifiers}}
|-
|GroupIDs||Gets an array containing the numeric IDs of selected maintenance groups when task performance is based on maintenance groups. '''Integer'''.
|-
|-
|MaintenanceTriggers||Gets the value of the maintenance trigger assigned to the task. '''Integer'''.
|MaintenanceTriggers||Gets the value of the maintenance trigger assigned to the task. '''Integer'''.
|-
|-
|TaskFrequencyIDOrig||{{DeprecatedAPIpic}} Gets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency with which a task is performed.  
|MiscCostModelID||Gets the numerical ID model that represents the task's Cost Per Task.  '''Integer'''.
|-
|-
|TaskFrequencyUnitIDOrig||{{DeprecatedAPIpic}} Gets the numeric ID for the original units of measurement of the intervals at which the task is performed.  '''Integer'''.
|MiscCostPerTimeModelID||Gets the numerical ID of the model that represents the task's Downtime Rate.  '''Integer'''.
|-
|-
|TaskFrequencyValueOrig||{{DeprecatedAPIpic}} Gets or sets the original fixed interval when the task is performed based on item age. '''Double'''.
|Name||Gets or sets the task's name. '''String'''.
|-
|-
|TaskFreqValueVariableIDOrig||{{DeprecatedAPIpic}} Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. '''Integer'''.
|OnCondBringItemDown||Gets or sets whether the task brings an item down. '''Boolean'''
|}
 
 
'''Basic Task Properties'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|DurationModelID||Gets the ID of the model that describes the duration of the task. '''Integer'''
|OnCondBringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
|-
|-
|CrewIDs||Gets the IDs of the crews assigned to the task.  '''Integer'''
|OnCondCrewIDs||Gets the IDs of the crews assigned to the task.  '''Integer'''.
|-
|-
|PoolID||Gets the IDs of the pool assigned to the task.  '''Integer'''.
|OnCondDurationModelID||Gets the ID of the model that describes the duration of the task.  '''Integer'''.
|}
 
 
'''Task Consequences'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|BringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
|OnCondFailureDetectionThreshold||Gets or sets the value for the task's failure detection threshold interval (0.9 = 90% percent of life. '''Double'''.
|-
|-
|BringItemDown||Indicates whether the task brings an item down. '''Boolean'''
|OnCondPerformTaskEvenIfItBringsSysDown||Indicates whether the task should be performed if bringing the item down causes the system to go down. '''Boolean'''
|-
|-
|PerformTaskEvenIfItBringsSysDown||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'''
|-
|-
|PerformTaskEvenIfItemAlreadyFailed||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'''.
|}
 
 
'''Restoration'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|ResFactorValue||Gets or sets the corrective task's Restoration Amount (0.9 = 90% restoration). '''Double'''.
|OnCondPFIntervalUnitID||Gets or sets the numerical ID for the units of measurement applied to the prior to failure interval. '''Integer'''.
|-
|-
|ResFactorType||Gets or sets a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair).
|OnCondPoolID||Gets the IDs of the pool assigned to the task. '''Integer'''.
|}
 
 
''Additional Costs to Consider'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|MiscCostModelID||Gets the numerical ID model that represents the task's Cost Per Task. '''Integer'''.
|OnCondResFactorValue||Gets or sets the corrective task's restoration Amount (0.9 = 90% restoration). '''Double'''.
|-
|-
|MiscCostPerTimeModelID||Gets the numerical ID of the model that represents the task's Downtime Rate.  '''Integer'''.
|OnCondResFactorType||Gets or set a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair).
|}
 
 
'''Failure Detection'''
{| {{APITable}}
|-
| style="width: 240px;"|OnCondFailureDetectionThreshold||Gets or sets the value for the task's failure detection threshold interval (0.9 = 90% percent of life. '''Double'''.
|-
|-
|OnCondUsePFInterval||Indicates whether the prior to failure interval should be used. '''Boolean'''
|OnCondUsePFInterval||Indicates whether the prior to failure interval should be used. '''Boolean'''
|-
|-
|OnCondPFInterval||Gets or sets the value for the task's prior to failure interval. '''Double'''.
|PackageID||Gets the numeric ID of the task package that will override the task's scheduling properties (0 = no override). '''Integer'''.
|-
|-
|OnCondPFIntervalUnitID||Gets or sets the numerical ID for the units of measurement applied to the prior to failure interval.  '''Integer'''.
|PerformTaskEvenIfItBringsSysDown||Indicates whether the task should be performed if bringing the item down causes the system to go down. '''Boolean'''
|}
 
 
'''On Condition Task (Upon Detection)'''
{| {{APITable}}
|-
|-
|style="width: 240px;"|OnCondDurationModelID||Gets the ID of the model that describes the duration of the task. '''Integer'''.
|PerformTaskEvenIfItemAlreadyFailed||Indicates whether the task should be performed if it has already failed. '''Boolean'''
|-
|-
|OnCondCrewIDs||Gets the IDs of the crews assigned to the task.  '''Integer'''.
|PoolID||Gets the IDs of the pool assigned to the task.  '''Integer'''.
|-
|-
|OnCondPoolID||Gets the IDs of the pool assigned to the task. '''Integer'''.
|PropInterval||Gets or sets the task's proposed interval value. '''Object'''.
|-
|-
|OnCondBringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
|PropIntervalUnitID||Gets or sets numeric ID for the units of measurement applied to the proposed interval. '''Integer'''.
|-
|-
|OnCondBringItemDown||Gets or sets whether the task brings an item down. '''Boolean'''
|RefDoc||Gets or sets the reference document that provides more detailed information about the task. '''String'''.
|-
|-
|OnCondPerformTaskEvenIfItBringsSysDown||Indicates whether the task should be performed if bringing the item down causes the system to go down. '''Boolean'''
|ResFactorType||Gets or sets a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair).
|-
|-
|OnCondPerformTaskEvenIfItemAlreadyFailed||Indicates whether the task should be performed if it has already failed. '''Boolean'''
|ResFactorValue||Gets or sets the corrective task's Restoration Amount (0.9 = 90% restoration). '''Double'''.
|-
|-
|OnCondResFactorValue||Gets or sets the corrective task's restoration Amount (0.9 = 90% restoration). '''Double'''.
|Status||Gets or sets the status of the task. '''String'''.
|-
|-
|OnCondResFactorType||Gets or set a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restores all accumulated damage or restores only damage accumulated since last repair).
|TaskAccess||Gets or sets the access that will be required in order to perform the task. '''String'''.
|}
 
 
'''RCM'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|Status||Gets or sets the status of the task. '''String'''.
|TaskClass||Gets or set one of the values of the '''[[TaskClassEnum Enumeration|TaskClassEnum]]''', which specifies the task's class (e.g., preventive task, inspection or on condition).
|-
|-
|PropInterval||Gets or sets the task's proposed interval value. '''Object'''.
|TaskFrequencyUnitID||Gets the numeric ID for the current units of measurement of the intervals at which the task is performed. '''Integer'''.
|-
|-
|PropIntervalUnitID||Gets or sets numeric ID for the units of measurement applied to the proposed interval. '''Integer'''.
|TaskFrequencyValue||Gets or sets the current fixed interval when the task is performed based on item age. '''Double'''.
|-
|-
|RefDoc||Gets or sets the reference document that provides more detailed information about the task. '''String'''.
|TaskFreqValueVariableID||Gets the numeric ID of the variable that currently represents the fixed interval when the task is performed based on item age. '''Integer'''.
|-
|-
|Condition||Gets or sets the condition that indicates that a failure will occur. '''String'''.
|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'''.
|TaskZone||Gets or sets the zone in which the task will be performed. '''String'''.
|-
|-
|TaskAccess||Gets or sets the access that will be required in order to perform the task. '''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'''.
|UDT1||Gets or sets the Task User Date 1. '''Object'''.
Line 166: Line 127:
|UN2||Gets or sets the Task User Number 2. '''Object'''.
|UN2||Gets or sets the Task User Number 2. '''Object'''.
|-
|-
|UDD1||Gets or sets the Task User Drop-Down 1. (Limited to 50 characters.) '''String'''.
|TaskFrequencyIDOrig||{{DeprecatedAPIpic}} Gets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency with which a task is performed.
|-
|TaskFrequencyUnitIDOrig||{{DeprecatedAPIpic}} Gets the numeric ID for the original units of measurement of the intervals at which the task is performed. '''Integer'''.
|-
|-
|UDD2||Gets or sets the Task User Drop-Down 2. (Limited to 50 characters.) '''String'''.
|TaskFrequencyValueOrig||{{DeprecatedAPIpic}} Gets or sets the original fixed interval when the task is performed based on item age. '''Double'''.
|}
 
 
'''Synthesis Identifiers'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|{{Template:API_TxtIdentifiers}}
|TaskFreqValueVariableIDOrig||{{DeprecatedAPIpic}} Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. '''Integer'''.
|}
|}

Revision as of 21:15, 5 October 2015

Template:InProgress

APIWiki.png


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 an item down. Boolean
BringSystemDown Indicates whether the task brings a system down. Boolean
Condition Gets or sets the condition that indicates that a failure will occur. String.
CrewIDs Gets the IDs of the crews assigned to the task. Integer
DiagramIDs Gets an array containing the numeric IDs of the diagrams the task is assigned to. Integer.
DurationModelID Gets the ID of the model that describes the duration of the task. Integer
GroupIDs Gets an array containing the numeric IDs of selected maintenance groups when task performance is based on maintenance groups. Integer.
Intervals Gets 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 the value of the maintenance trigger assigned to the task. Integer.
MiscCostModelID Gets the numerical ID model that represents the task's Cost Per Task. Integer.
MiscCostPerTimeModelID Gets the numerical ID of the model that represents the task's Downtime Rate. Integer.
Name Gets or sets the task's name. String.
OnCondBringItemDown Gets or sets whether the task brings an item down. Boolean
OnCondBringSystemDown Indicates whether the task brings a system down. Boolean
OnCondCrewIDs Gets the IDs of the crews assigned to the task. Integer.
OnCondDurationModelID Gets the ID of the model that describes the duration of the task. 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.
Retrieved from "https://www.reliawiki.com/index.php?title=CScheduledTask_Class&oldid=60921"