CScheduledTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 7: Line 7:


== Properties ==
== Properties ==
'''Scheduled Task'''
*TaskClass (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Sets or gets the Task Class (e.g., preventive task).}}
*TaskTypeID (as ''integer'') {{APIComment|Gets the numerical ID of the task type the resource belongs to.}}
*DiagramIDs (as ''integer() '') {{APIComment|Gets an array of numerical IDs for the diagrams the task is assigned to. (Note: May be removed/hidden.)}}
'''Task Scheduling'''
*TaskFrequencyUnitIDOrig (as ''integer'') {{APIComment|Gets the ID of the task frequency unit for which the resource belongs to. (Note:May be removed/hidden.)}}
*TaskFrequencyValue (as ''double'') {{APIComment|Sets or gets the Fixed Interval when the task is performed based on item age.}}
*TaskFreqValueVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the Fixed Interval when the task is performed based on item age.)}}
*Intervals (as ''double()'') {{APIComment|Gets an array of interval start values when the task is performed based on dynamic intervals.}}
*TaskFrequencyUnitID (as ''integer'') {{APIComment|Gets the numerical ID of the units of measurement for the intervals at which the task is performed.}}
*PackageID (as ''integer'') {{APIComment|Gets the numerical ID of the task package that will override this task's scheduling properties (0 = no override). (Note: May be removed/hidden.)}}
*GroupIDs (as ''integer()'') {{APIComment|Gets an array of numerical IDs for maintenance groups when task performance is based on maintenance groups. (Note:May be removed/hidden.)}}


*TaskClass (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Sets or gets the task class as a task class enumeration for which the resource belongs to.}}
*TaskTypeID (as ''integer'') {{APIComment|Gets the ID of the task type the resource belongs to.}}
*PackageID (as ''integer'') {{APIComment|Gets the ID of package for which the resource belongs to. (Note: May be removed/hidden.)}}
*TaskFrequencyValue (as ''double'') {{APIComment|Sets or gets task frequency.}}
*TaskFrequencyUnitID (as ''integer'') {{APIComment|Gets the ID of the task frequency value variable for which the resource belongs to.}}
*TaskFreqValueVariableID (as ''integer'') {{APIComment|Gets the task as a data access object for the resource belonged to.)}}
*Intervals (as ''double'') {{APIComment|Gets interval values as a list.}}
*GroupIDs (as ''integer()'') {{APIComment|Gets the ID of group that the task belongs to. (Note:May be removed/hidden.)}}
*DiagramIDs (as ''integer() '') {{APIComment|Gets the IDs of diagram as a list for which the resource belongs to. (Note: May be removed/hidden.)}}
*PerformTaskEvenIfItemAlreadyFailed (as ''boolean'') {{APIComment|Whether or not the task should be performed if it has already failed.}}
*TaskFrequencyIDOrig (as ''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]'') {{APIComment|Gets the ID of the task frequency unit as task frequency enumeration for which the resource belongs to. (Note: May be removed/hidden.)}}
*TaskFrequencyIDOrig (as ''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]'') {{APIComment|Gets the ID of the task frequency unit as task frequency enumeration for which the resource belongs to. (Note: May be removed/hidden.)}}
*TaskFrequencyValueOrig (as ''double'') {{APIComment|Sets or gets task frequency. (Note:May be removed/hidden.)}}
*TaskFrequencyValueOrig (as ''double'') {{APIComment|Sets or gets task frequency. (Note:May be removed/hidden.)}}
*TaskFrequencyUnitIDOrig (as ''integer'') {{APIComment|Gets the ID of the task frequency unit for which the resource belongs to. (Note:May be removed/hidden.)}}
*TaskFreqValueVariableIDOrig  (as ''integer'') {{APIComment|Gets the ID of the task frequency unit variable for which the resource belongs to. (Note: May be removed/hidden.)}}
*TaskFreqValueVariableIDOrig  (as ''integer'') {{APIComment|Gets the ID of the task frequency unit variable for which the resource belongs to. (Note: May be removed/hidden.)}}
*OnCondUsePFInterval (as ''boolean'') {{APIComment|Whether or not the prior to failure interval should be used.}}
 
*OnCondPFInterval (as ''double'') {{APIComment|Gets the value for the prior to failure interval for which the resource belongs to.}}
'''Basic Task Properties'''
*OnCondPFIntervalUnitID (as ''integer'') {{APIComment|Gets the ID of the prior to failure interval for which the resource belongs to.}}
*OnCondFailureDetectionThreshold  (as ''double'') {{APIComment|Gets the value for the failure detection threshold interval for which the resource belongs to.}}
*OnCondDurationModelID (as ''integer'') {{APIComment|Gets the ID of the prior to failure interval for which the resource belongs to.}}
*OnCondDurationModelID (as ''integer'') {{APIComment|Gets the ID of the prior to failure interval for which the resource belongs to.}}
*OnCondCrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned that the resource belongs to.}}
*OnCondPoolID (as ''integer'') {{APIComment|Gets the IDs of the pool assigned that the resource belongs to.}}
'''Task Consequences'''
*OnCondBringSystemDown (as ''boolean'') {{APIComment|Whether or not the task brings a system down.}}
*OnCondBringSystemDown (as ''boolean'') {{APIComment|Whether or not the task brings a system down.}}
*OnCondBringItemDown (as ''boolean'') {{APIComment|Whether or not the task brings an item down.}}
*OnCondBringItemDown (as ''boolean'') {{APIComment|Whether or not the task brings an item down.}}
*OnCondPerformTaskEvenIfItBringsSysDown  (as ''boolean'') {{APIComment|Whether or not you still perform the task if bringing the item down causes the system to go down. }}
*OnCondPerformTaskEvenIfItBringsSysDown  (as ''boolean'') {{APIComment|Whether or not you still perform the task if bringing the item down causes the system to go down. }}
'''Restoration'''
*OnCondResFactorType (as ''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]'') {{APIComment|Sets or gets the type for the restoration enumeration the resource belongs to.}}
*OnCondResFactorType (as ''[[TaskRestorationTypeEnum Enumeration|TaskRestorationTypeEnum]]'') {{APIComment|Sets or gets the type for the restoration enumeration the resource belongs to.}}
*OnCondResFactorValue  (as ''double'') {{APIComment|Sets or gets the value for the restoration amount the resource belongs to.}}
*OnCondResFactorValue  (as ''double'') {{APIComment|Sets or gets the value for the restoration amount the resource belongs to.}}
*OnCondCrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned that the resource belongs to.}}
 
*OnCondPoolID (as ''integer'') {{APIComment|Gets the IDs of the pool assigned that the resource belongs to.}}
'''Additional Costs to Consider'''
*OCMiscCostModelID (as ''integer'') {{APIComment|Gets the ID of the miscellaneous cost model based on the cost per task and downtime rate the resource belongs to.}}
*OCMiscCostModelID (as ''integer'') {{APIComment|Gets the ID of the miscellaneous cost model based on the cost per task and downtime rate the resource belongs to.}}
*OCMiscCostPerTimeModelID (as ''integer'') {{APIComment|Gets the ID of the miscellaneous cost per unit of time model that the resource belongs to.}}
*OCMiscCostPerTimeModelID (as ''integer'') {{APIComment|Gets the ID of the miscellaneous cost per unit of time model that the resource belongs to.}}
'''Failure Detection'''
*OnCondFailureDetectionThreshold  (as ''double'') {{APIComment|Gets the value for the failure detection threshold interval for which the resource belongs to.}}
*OnCondUsePFInterval (as ''boolean'') {{APIComment|Whether or not the prior to failure interval should be used.}}
*OnCondPFInterval (as ''double'') {{APIComment|Gets the value for the prior to failure interval for which the resource belongs to.}}
*OnCondPFIntervalUnitID (as ''integer'') {{APIComment|Gets the ID of the prior to failure interval for which the resource belongs to.}}
'''User-Defined'''
*UDT1 (as ''object'') {{APIComment|Sets or returns the Action User Date 1. Returns object of the System.Date type.}}
*UDT2 (as ''object'') {{APIComment|Sets or returns the Action User Date 2. Returns object of the System.Date type.}}
*UN1 (as ''object'') {{APIComment|Sets or returns the Action User Number 1. Returns object of the System.Double type.}}
*UN2 (as ''object'') {{APIComment|Sets or returns the Action User Number 2. Returns object of the System.Double type.}}
*UDD1 (as ''string'') {{APIComment|Sets or returns the Action User Drop-Down 1. (Limited to 50 characters.)}}
*UDD2 (as ''string'') {{APIComment|Sets or returns the Action User Drop-Down 2. (Limited to 50 characters.)}}
'''Other'''
*PerformTaskEvenIfItemAlreadyFailed (as ''boolean'') {{APIComment|Whether or not the task should be performed if it has already failed.}}
*MaintenanceTriggers (as ''integer'') {{APIComment|Gets the value of the maintenance trigger the resource belongs to. (Note: May be removed/hidden.)}}
*MaintenanceTriggers (as ''integer'') {{APIComment|Gets the value of the maintenance trigger the resource belongs to. (Note: May be removed/hidden.)}}
*UDT1 (as ''object'') {{APIComment|Sets or gets UDT1 as an object.}}
*UDT2 (as ''object'') {{APIComment|Sets or gets UDT2 as an object.}}
*UN1 (as ''object'') {{APIComment|Sets or gets UN1 as an object.}}
*UN2 (as ''object'') {{APIComment|Sets or gets UN1 as an object. }}
*UDD1 (as ''string'') {{APIComment|Sets or gets the UDD1 of the resource (the one used in the repository)}}
*UDD2 (as ''string'') {{APIComment|Sets or gets the UDD2 of the resource (the one used in the repository)}}
*Status (as ''string'') {{APIComment|Sets or gets the status of the resource (the one used in the repository)}}
*Status (as ''string'') {{APIComment|Sets or gets the status of the resource (the one used in the repository)}}
*PropInterval (as ''object'') {{APIComment|Sets or gets the internal type (the one used in the repository)}}
*PropInterval (as ''object'') {{APIComment|Sets or gets the internal type (the one used in the repository)}}

Revision as of 18:06, 12 March 2014


The cScheduledTask class allows you to choose or create multiple scheduled tasks for the URD. Each task may be a preventive maintenance, inspections or on condition task. The tasks are displayed in their priority order, which is the order in which they will be performed.

Constructors

  • cScheduledTask Creates a new scheduled task.

Properties

Scheduled Task

  • TaskClass (as TaskClassEnum) Sets or gets the Task Class (e.g., preventive task).
  • TaskTypeID (as integer) Gets the numerical ID of the task type the resource belongs to.
  • DiagramIDs (as integer() ) Gets an array of numerical IDs for the diagrams the task is assigned to. (Note: May be removed/hidden.)

Task Scheduling

  • TaskFrequencyUnitIDOrig (as integer) Gets the ID of the task frequency unit for which the resource belongs to. (Note:May be removed/hidden.)
  • TaskFrequencyValue (as double) Sets or gets the Fixed Interval when the task is performed based on item age.
  • TaskFreqValueVariableID (as integer) Gets the numerical ID of the variable that represents the Fixed Interval when the task is performed based on item age.)
  • Intervals (as double()) Gets an array of interval start values when the task is performed based on dynamic intervals.
  • TaskFrequencyUnitID (as integer) Gets the numerical ID of the units of measurement for the intervals at which the task is performed.
  • PackageID (as integer) Gets the numerical ID of the task package that will override this task's scheduling properties (0 = no override). (Note: May be removed/hidden.)
  • GroupIDs (as integer()) Gets an array of numerical IDs for maintenance groups when task performance is based on maintenance groups. (Note:May be removed/hidden.)
  • TaskFrequencyIDOrig (as TaskFrequencyEnum) Gets the ID of the task frequency unit as task frequency enumeration for which the resource belongs to. (Note: May be removed/hidden.)
  • TaskFrequencyValueOrig (as double) Sets or gets task frequency. (Note:May be removed/hidden.)
  • TaskFreqValueVariableIDOrig (as integer) Gets the ID of the task frequency unit variable for which the resource belongs to. (Note: May be removed/hidden.)

Basic Task Properties

  • OnCondDurationModelID (as integer) Gets the ID of the prior to failure interval for which the resource belongs to.
  • OnCondCrewIDs (as integer()) Gets the IDs of the crews assigned that the resource belongs to.
  • OnCondPoolID (as integer) Gets the IDs of the pool assigned that the resource belongs to.

Task Consequences

  • OnCondBringSystemDown (as boolean) Whether or not the task brings a system down.
  • OnCondBringItemDown (as boolean) Whether or not the task brings an item down.
  • OnCondPerformTaskEvenIfItBringsSysDown (as boolean) Whether or not you still perform the task if bringing the item down causes the system to go down.

Restoration

  • OnCondResFactorType (as TaskRestorationTypeEnum) Sets or gets the type for the restoration enumeration the resource belongs to.
  • OnCondResFactorValue (as double) Sets or gets the value for the restoration amount the resource belongs to.

Additional Costs to Consider

  • OCMiscCostModelID (as integer) Gets the ID of the miscellaneous cost model based on the cost per task and downtime rate the resource belongs to.
  • OCMiscCostPerTimeModelID (as integer) Gets the ID of the miscellaneous cost per unit of time model that the resource belongs to.

Failure Detection

  • OnCondFailureDetectionThreshold (as double) Gets the value for the failure detection threshold interval for which the resource belongs to.
  • OnCondUsePFInterval (as boolean) Whether or not the prior to failure interval should be used.
  • OnCondPFInterval (as double) Gets the value for the prior to failure interval for which the resource belongs to.
  • OnCondPFIntervalUnitID (as integer) Gets the ID of the prior to failure interval for which the resource belongs to.

User-Defined

  • UDT1 (as object) Sets or returns the Action User Date 1. Returns object of the System.Date type.
  • UDT2 (as object) Sets or returns the Action User Date 2. Returns object of the System.Date type.
  • UN1 (as object) Sets or returns the Action User Number 1. Returns object of the System.Double type.
  • UN2 (as object) Sets or returns the Action User Number 2. Returns object of the System.Double type.
  • UDD1 (as string) Sets or returns the Action User Drop-Down 1. (Limited to 50 characters.)
  • UDD2 (as string) Sets or returns the Action User Drop-Down 2. (Limited to 50 characters.)

Other

  • PerformTaskEvenIfItemAlreadyFailed (as boolean) Whether or not the task should be performed if it has already failed.
  • MaintenanceTriggers (as integer) Gets the value of the maintenance trigger the resource belongs to. (Note: May be removed/hidden.)
  • Status (as string) Sets or gets the status of the resource (the one used in the repository)
  • PropInterval (as object) Sets or gets the internal type (the one used in the repository)
  • PropIntervalUnitID (as integer) Sets or gets ID of the interval unit type (the one used in the repository)
  • TaskZone (as string) Sets or gets the zone in which the task will be performed of the resource (the one used in the repository)
  • TaskAccess (as string) Sets or gets the access that will be required in order to perform the task of the resource (the one used in the repository)
  • Condition (as string) Sets or gets the condition that indicates that a failure will occur of the resource (the one used in the repository)
  • RefDoc (as string) Sets or gets the reference document that provides more detailed information about the task of the resource (the one used in the repository)