CScheduledTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 240px;"|cScheduledTask||Creates an instance of the CSheduledTask Class.
| style="width: 240px;"|cScheduledTask||Creates an instance of the cSheduledTask class.
|-
|-
|[[CScheduledTask_Constructors|cScheduledTask()]]||{{:CScheduledTask_Constructors}}
|[[CScheduledTask_Constructors|cScheduledTask()]]||{{:CScheduledTask_Constructors}}
Line 53: Line 53:
|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||Gets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency with which a task is performed. [[Image:DeprecatedAPI.png]]
|TaskFrequencyIDOrig||Gets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies the frequency with which a task is performed. {{DeprecatedAPIpic}}
|-
|-
|TaskFrequencyUnitIDOrig||Gets the numeric ID for the original units of measurement of the intervals at which the task is performed.  '''Integer'''. [[Image:DeprecatedAPI.png]]
|TaskFrequencyUnitIDOrig||Gets the numeric ID for the original units of measurement of the intervals at which the task is performed.  '''Integer'''. {{DeprecatedAPIpic}}
|-
|-
|TaskFrequencyValueOrig||Gets or sets the original fixed interval when the task is performed based on item age. '''Double'''. [[Image:DeprecatedAPI.png]]
|TaskFrequencyValueOrig||Gets or sets the original fixed interval when the task is performed based on item age. '''Double'''. {{DeprecatedAPIpic}}
|-
|-
|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]]
|TaskFreqValueVariableIDOrig||Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. '''Integer'''. {{DeprecatedAPIpic}}
|}
|}


Line 92: Line 92:
| style="width: 240px;"|ResFactorValue||Gets or sets the corrective task's Restoration Amount (0.9 = 90% restoration). '''Double'''.
| style="width: 240px;"|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|TaskRestorationTypeEnum]]''' enumeration, which specifies the damage the restoration applies to (i.e., restored all accumulated damage or restores only damage accumulated since last repair).
|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).
|}
|}


Line 121: Line 121:
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 240px;"|OnCondDurationModelID||Gets the ID of the model that describes the duration of the task.  '''Integer'''.
|style="width: 240px;"|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'''.
|OnCondCrewIDs||Gets the IDs of the crews assigned to the task.  '''Integer'''.
Line 137: Line 137:
|OnCondResFactorValue||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'''.
|-
|-
|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).
|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).
|}
|}


Revision as of 22:17, 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.   Deprecated  
TaskFrequencyUnitIDOrig Gets the numeric ID for the original units of measurement of the intervals at which the task is performed. Integer.   Deprecated  
TaskFrequencyValueOrig Gets or sets the original fixed interval when the task is performed based on item age. Double.   Deprecated  
TaskFreqValueVariableIDOrig Gets the numeric ID of the variable that originally represented the fixed interval when the task is performed based on item age. Integer.   Deprecated  


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., restores 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., restores 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=60359"