CScheduledTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cScheduledTask Class}}
{{InProgress}}{{DISPLAYTITLE:cScheduledTask Class}}{{Template:API}}{{Template:APIBreadcrumbClass}}
{{Template:APIClass|Resource Classes|Resource Classes}}  
{{Template:CScheduledTask Class.Cmt}}


{{Template:ResourceLinkToRepositoryClass.Cmt}}
== Constructors ==
*cScheduledTask {{APIComment|Creates a new scheduled task.}}


== Properties ==
<onlyinclude>Represents a scheduled task resource. The task may be a preventive maintenance, inspection or on condition task.</onlyinclude>
'''General'''
 
*Name (as ''string'') {{APIComment|Gets or sets the task's Name.}}
==Constructors==
*TaskClass (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Gets or sets the task's class (i.e., preventive task).}}
{| {{APITable}}
*TaskTypeID (as ''integer'') {{APIComment|Gets or sets the numerical ID of the task's type (e.g., restoration, condition based).}}
|-
*DiagramIDs (as ''integer() '') {{APIComment|Gets an array of numerical IDs for the diagrams the task is assigned to. (Note: Not shown in software.)}}
| style="width: 240px;"|cScheduledTask||Creates an instance of the CSheduledTask Class.
|-
|[[CScheduledTask_Constructors|cScheduledTask()]]||{{:CScheduledTask_Constructors}}
|}
 
 
==Methods==
{| {{APITable}}
|-
| style="width: 240px;"|SetCrewIDs|| {{APIComment|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|| {{APIComment|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==
{| {{APITable}}
|-
| style="width: 240px;"|Name||Gets or sets the task's name. '''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).
|-
|TaskTypeID||Gets or sets the numeric ID of the task's class. '''Integer'''.
|-
|DiagramIDs||Gets an array containing the numeric IDs of the diagrams the task is assigned to. '''Integer'''.
|}
 


'''Task Scheduling'''
'''Task Scheduling'''
*TaskFrequencyIDOrig (as ''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]'') {{APIComment|Gets the enumeration that specifies when the task is performed.}}
{| {{APITable}}
*TaskFrequencyUnitIDOrig (as ''integer'') {{APIComment|Gets the numerical ID for the original units of measurement of the intervals at which the task is performed. (Note: Not shown in software.)}}
|-
*TaskFrequencyUnitID (as ''integer'') {{APIComment|Gets the numerical ID for the current units of measurement of the intervals at which the task is performed.}}
| style="width: 240px;"|TaskFrequencyUnitID||Gets the numeric ID for the current units of measurement of the intervals at which the task is performed. '''Integer'''.
*TaskFrequencyValueOrig (as ''double'') {{APIComment|Gets or sets the original Fixed Interval when the task is performed based on item age. (Note: May be removed/hidden.)}}
|-
*TaskFrequencyValue (as ''double'') {{APIComment|Gets or sets the current Fixed Interval when the task is performed based on item age.}}
|TaskFrequencyValue||Gets or sets the current fixed interval when the task is performed based on item age. '''Double'''.
*TaskFreqValueVariableIDOrig  (as ''integer'') {{APIComment|Gets the numerical ID of the variable that originally represented the Fixed Interval when the task is performed based on item age. (Note: Not shown in software.)}}
|-
*TaskFreqValueVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that currently represents the Fixed Interval when the task is performed based on item age.)}}
|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 (as ''double()'') {{APIComment|Gets an array of interval start values when the task is performed based on dynamic intervals.}}
|-
*PackageID (as ''integer'') {{APIComment|Gets the numerical ID of the task package that will override this task's scheduling properties (0 &#61; no override).}}
|Intervals||Gets an array containing the interval start values when the task is performed based on dynamic intervals. '''Double'''.
*GroupIDs (as ''integer()'') {{APIComment|Gets an array of numerical IDs for selected maintenance groups when task performance is based on maintenance groups. (Note:May be removed/hidden.)}}
|-
*MaintenanceTriggers (as ''integer'') {{APIComment|Gets the value of the maintenance trigger assigned to the task. (Note: May be removed/hidden.)}}
|PackageID||Gets the numeric ID of the task package that will override the task's scheduling properties (0 &#61; no override). '''Integer'''.
|-
|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'''.
|-
|TaskFrequencyIDOrig||Gets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency with which a task is performed. [[Image:DeprecatedAPI.png]]
|-
|TaskFrequencyUnitIDOrig||Gets the numeric ID for the original units of measurement of the intervals at which the task is performed.  '''Integer'''. [[Image:DeprecatedAPI.png]]
|-
|TaskFrequencyValueOrig||Gets or sets the original fixed interval when the task is performed based on item age. '''Double'''. [[Image:DeprecatedAPI.png]]
|-
|TaskFreqValueVariableIDOrig||Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. '''Integer'''. [[Image:DeprecatedAPI.png]]
|}
 


'''Basic Task Properties'''
'''Basic Task Properties'''
*DurationModelID (as ''integer'') {{APIComment|Gets the ID of the model that describes the duration of the task.}}
{| {{APITable}}
*CrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned to the task.}}
|-
*SetCrewIDs (ByRef arr() as ''integer'') {{APIComment|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.}}
| style="width: 240px;"|DurationModelID||Gets the ID of the model that describes the duration of the task. '''Integer'''
*GetCrewIDs (ByRef arr() as ''integer'') {{APIComment|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.}}
|-
*PoolID (as ''integer'') {{APIComment|Gets the IDs of the pool assigned to the task.}}
|CrewIDs||Gets the IDs of the crews assigned to the task. '''Integer'''
|-
|PoolID||Gets the IDs of the pool assigned to the task. '''Integer'''.
|}
 


'''Task Consequences'''
'''Task Consequences'''
*BringSystemDown (as ''boolean'') {{APIComment|Gets or sets whether the task brings a system down.}}
{| {{APITable}}
*BringItemDown (as ''boolean'') {{APIComment|Gets or sets whether the task brings an item down.}}
|-
*PerformTaskEvenIfItBringsSysDown  (as ''boolean'') {{APIComment|Gets or sets whether the task should be performed if bringing the item down causes the system to go down.}}
| style="width: 240px;"|BringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
*PerformTaskEvenIfItemAlreadyFailed (as ''boolean'') {{APIComment|Gets or sets whether the task should be performed if it has already failed.}}
|-
|BringItemDown||Indicates whether the task brings an item down. '''Boolean'''
|-
|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'''
|}
 


'''Restoration'''
'''Restoration'''
*ResFactorValue (as ''double'') {{APIComment|Gets or sets the corrective task's Restoration Amount (0.9 &#61; 90% restoration).}}
{| {{APITable}}
*ResFactorType (as ''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]'') {{APIComment|Gets or sets the enumeration for the damage the restoration applies to (i.e., all damage or only damage since last repair.}}
|-
| style="width: 240px;"|ResFactorValue||Gets or sets the corrective task's Restoration Amount (0.9 &#61; 90% restoration). '''Double'''.
|-
|ResFactorType||Gets or sets a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restored all accumulated damage or restores only damage accumulated since last repair).
|}
 
 
''Additional Costs to Consider'''
{| {{APITable}}
|-
| style="width: 240px;"|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'''.
|}


'''Additional Costs to Consider'''
*MiscCostModelID (as ''integer'') {{APIComment|Gets the numerical ID model that represents the task's Cost Per Task.}}
*MiscCostPerTimeModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the task's Downtime Rate.}}


'''Failure Detection'''
'''Failure Detection'''
*OnCondFailureDetectionThreshold  (as ''double'') {{APIComment|Gets or sets the value for the task's failure detection threshold interval (0.9 &#61; 90% percent of life.}}
{| {{APITable}}
*OnCondUsePFInterval (as ''boolean'') {{APIComment|Gets or sets whether the prior to failure interval should be used.}}
|-
*OnCondPFInterval (as ''double'') {{APIComment|Gets or sets the value for the task's prior to failure interval.}}
| style="width: 240px;"|OnCondFailureDetectionThreshold||Gets or sets the value for the task's failure detection threshold interval (0.9 &#61; 90% percent of life. '''Double'''.
*OnCondPFIntervalUnitID (as ''integer'') {{APIComment|Gets or sets the numerical ID for the units of measurement applied to the prior to failure interval.}}
|-
|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'''.
|-
|OnCondPFIntervalUnitID||Gets or sets the numerical ID for the units of measurement applied to the prior to failure interval. '''Integer'''.
|}
 


'''On Condition Task (Upon Detection)'''
'''On Condition Task (Upon Detection)'''
*OnCondDurationModelID (as ''integer'') {{APIComment|Gets the ID of the model that describes the duration of the task.}}
{| {{APITable}}
*OnCondCrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned to the task.}}
|-
*OnCondPoolID (as ''integer'') {{APIComment|Gets the IDs of the pool assigned to the task.}}
| style="width: 240px;"|OnCondDurationModelID||Gets the ID of the model that describes the duration of the task. '''Integer'''.
*OnCondBringSystemDown (as ''boolean'') {{APIComment|Gets or sets whether the task brings a system down.}}
|-
*OnCondBringItemDown (as ''boolean'') {{APIComment|Gets or sets whether the task brings an item down.}}
|OnCondCrewIDs||Gets the IDs of the crews assigned to the task. '''Integer'''.
*OnCondPerformTaskEvenIfItBringsSysDown  (as ''boolean'') {{APIComment|Gets or sets whether the task should be performed if bringing the item down causes the system to go down.}}
|-
*OnCondPerformTaskEvenIfItemAlreadyFailed (as ''boolean'') {{APIComment|Gets or sets whether the task should be performed if it has already failed.}}
|OnCondPoolID||Gets the IDs of the pool assigned to the task. '''Integer'''.
*OnCondResFactorValue (as ''double'') {{APIComment|Gets or sets the corrective task's Restoration Amount (0.9 &#61; 90% restoration).}}
|-
*OnCondResFactorType (as ''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]'') {{APIComment|Gets or sets the enumeration for the damage the restoration applies to (i.e., all damage or only damage since last repair.}}
|OnCondBringSystemDown||Indicates whether the task brings a system down. '''Boolean'''
|-
|OnCondBringItemDown||Gets or sets 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'''
|-
|OnCondPerformTaskEvenIfItemAlreadyFailed||Indicates whether the task should be performed if it has already failed. '''Boolean'''
|-
|OnCondResFactorValue||Gets or sets the corrective task's restoration Amount (0.9 &#61; 90% restoration). '''Double'''.
|-
|OnCondResFactorType||Gets or set a value from the '''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restored all accumulated damage or restores only damage accumulated since last repair).
|}
 


'''RCM'''
'''RCM'''
*Status (as ''string'') {{APIComment|Gets or sets the status of the task.}}
{| {{APITable}}
*PropInterval (as ''object'') {{APIComment|Gets or sets the task's Proposed Interval value.}}
|-
*PropIntervalUnitID (as ''integer'') {{APIComment|Gets or sets numerical ID for the units of measurement applied to the Proposed Interval.}}
| style="width: 240px;"|Status||Gets or sets the status of the task. '''String'''.
*RefDoc (as ''string'') {{APIComment|Gets or sets the reference document that provides more detailed information about the task.}}
|-
*Condition (as ''string'') {{APIComment|Gets or sets the condition that indicates that a failure will occur.}}
|PropInterval||Gets or sets the task's proposed interval value. '''Object'''.
*TaskZone (as ''string'') {{APIComment|Gets or sets the zone in which the task will be performed.}}
|-
*TaskAccess (as ''string'') {{APIComment|Gets or sets the access that will be required in order to perform the task.}}
|PropIntervalUnitID||Gets or sets numeric ID for the units of measurement applied to the proposed interval. '''Integer'''.
*UDT1 (as ''object'') {{APIComment|Gets or sets the Task User Date 1. Returns object of the System.Date type.}}
|-
*UDT2 (as ''object'') {{APIComment|Gets or sets the Task User Date 2. Returns object of the System.Date type.}}
|RefDoc||Gets or sets the reference document that provides more detailed information about the task. '''String'''.
*UN1 (as ''object'') {{APIComment|Gets or sets the Task User Number 1. Returns object of the System.Double type.}}
|-
*UN2 (as ''object'') {{APIComment|Gets or sets the Task User Number 2. Returns object of the System.Double type.}}
|Condition||Gets or sets the condition that indicates that a failure will occur. '''String'''.
*UDD1 (as ''string'') {{APIComment|Gets or sets the Task User Drop-Down 1. (Limited to 50 characters.)}}
|-
*UDD2 (as ''string'') {{APIComment|Gets or sets the Task User Drop-Down 2. (Limited to 50 characters.)}}
|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'''.
|-
|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'''.
|-
|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'''.
|}


== Methods ==


'''Set/Return Item Properties'''
'''Synthesis Identifiers'''
*[[cScheduledTask.ItemCategoryID|ItemCategoryID(Integer)]] {{APIComment|{{Template:ItemCategoryID.Cmt}}}}
{| {{APITable}}
*[[cScheduledTask.ItemPartNumber|ItemPartNumber(String)]] {{APIComment|{{Template:ItemPartNumber.Cmt}}}}
|-
*[[cScheduledTask.ItemVersion|ItemVersion(String)]] {{APIComment|{{Template:ItemVersion.Cmt}}}}
| style="width: 240px;"|{{Template:API_TxtIdentifiers}}
*[[cScheduledTask.ItemSupplier|ItemSupplier(String)]] {{APIComment|{{Template:ItemSupplier.Cmt}}}}
|}
*[[cScheduledTask.ItemApplication|ItemApplication(String)]] {{APIComment|{{Template:ItemApplication.Cmt}}}}
*[[cScheduledTask.ItemDescription|ItemDescription(String)]] {{APIComment|{{Template:ItemDescription.Cmt}}}}
*[[cScheduledTask.ItemComments|ItemComments(String)]] {{APIComment|{{Template:ItemComments.Cmt}}}}
*[[cScheduledTask.ItemKeywords|ItemKeywords(String)]] {{APIComment|{{Template:ItemKeywords.Cmt}}}}

Revision as of 20:55, 11 August 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
Name Gets or sets the task's name. 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).
TaskTypeID Gets or sets the numeric ID of the task's class. Integer.
DiagramIDs Gets an array containing the numeric IDs of the diagrams the task is assigned to. Integer.


Task Scheduling

Name Description
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.
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.
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.
TaskFrequencyIDOrig Gets a value from the TaskFrequencyEnum, which specifies the frequency with which a task is performed. DeprecatedAPI.png
TaskFrequencyUnitIDOrig Gets the numeric ID for the original units of measurement of the intervals at which the task is performed. Integer. DeprecatedAPI.png
TaskFrequencyValueOrig Gets or sets the original fixed interval when the task is performed based on item age. Double. DeprecatedAPI.png
TaskFreqValueVariableIDOrig Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. Integer. DeprecatedAPI.png


Basic Task Properties

Name Description
DurationModelID Gets the ID of the model that describes the duration of the task. Integer
CrewIDs Gets the IDs of the crews assigned to the task. Integer
PoolID Gets the IDs of the pool assigned to the task. Integer.


Task Consequences

Name Description
BringSystemDown Indicates whether the task brings a system down. Boolean
BringItemDown Indicates whether the task brings an item down. Boolean
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


Restoration

Name Description
ResFactorValue Gets or sets the corrective task's Restoration Amount (0.9 = 90% restoration). Double.
ResFactorType Gets or sets a value from the TaskRestorationTypeEnum enumeration, which specifies the damage the restoration applies to (i.e., restored all accumulated damage or restores only damage accumulated since last repair).


Additional Costs to Consider'

Name Description
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.


Failure Detection

Name Description
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
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.


On Condition Task (Upon Detection)

Name Description
OnCondDurationModelID Gets the ID of the model that describes the duration of the task. Integer.
OnCondCrewIDs Gets the IDs of the crews assigned to the task. Integer.
OnCondPoolID Gets the IDs of the pool assigned to the task. Integer.
OnCondBringSystemDown Indicates whether the task brings a system down. Boolean
OnCondBringItemDown Gets or sets 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
OnCondPerformTaskEvenIfItemAlreadyFailed Indicates whether the task should be performed if it has already failed. Boolean
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., restored all accumulated damage or restores only damage accumulated since last repair).


RCM

Name Description
Status Gets or sets the status of the task. String.
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.
Condition Gets or sets the condition that indicates that a failure will occur. 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.
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.
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.


Synthesis Identifiers

Name Description
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
Retrieved from "https://www.reliawiki.com/index.php?title=CScheduledTask_Class&oldid=60348"