CCorrectiveTask Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cCorrectiveTask Class}}
{{InProgress}}{{DISPLAYTITLE:cCorrectiveTask Class}}{{Template:API}}{{Template:APIBreadcrumbClass}}
{{Template:APIClass|Resource Classes|Resource Classes}}  
 
{{CCorrectiveTask Class.Cmt}}  
 
<onlyinclude>Represents a corrective task resource.</onlyinclude>
 
==Constructors==
{| {{APITable}}
|-
| style="width: 240px;"|CCorrectiveTask||Creates an instance of the cCorrectiveTask class.
|-
|[[CCorrectiveTask Constructors|cCorrectiveTask()]]||{{:CCorrectiveTask Constructors}}
|-
|GetCrewIDs||
|-
|SetCrewIDs||
|}


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


== Properties  ==
== Properties  ==
'''General'''
{| {{APITable}}
*Name (as ''string'') {{APIComment|Gets or sets the name of the task.}}
|-
*ID (as ''integer'') {{APIComment|Gets the numerical ID of the resource.}}
| style="width: 240px;"|Name||Gets or sets the name of the task. '''String'''.
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the task belongs to.}}
|-
|ID||Gets the numeric ID of the task. '''Integer'''
|-
|ProjectID||Gets the numeric ID of the project the task belongs to. '''Integer'''.
|}
 


'''Task Scheduling'''
'''Task Scheduling'''
*TaskFrequencyID (as ''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]'') {{APIComment|Gets the frequency with which the task is performed.}}
{| {{APITable}}
|-
| style="width: 240px;"|TaskFrequencyID||Gets or sets a value from the '''[[TaskFrequencyEnum Enumeration|TaskFrequencyEnum]]''', which specifies frequency with which the task is performed.
|}
 


'''Basic Repair Properties'''
'''Basic Repair Properties'''
*DurationModelID (as ''integer'') {{APIComment|Gets the ID of the task duration model assigned to the resource.}}
{| {{APITable}}
*CrewIDs (as ''integer()'') {{APIComment|Gets the IDs of the crews assigned to the resource.}}
|-
*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;"|CrewIDs||Gets the IDs of the crews assigned to the resource. '''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 ID of the pools assigned to the resource.}}
|DurationModelID||Gets the ID of the task duration model assigned to the resource. '''Integer'''.
|-
|PoolID||Gets the ID of the pools assigned to the resource. '''Integer'''.
|}
 


'''Task Consequences'''
'''Task Consequences'''
*BringSystemDown (as ''boolean'') {{APIComment|Gets or sets whether this task will bring the system down.}}
{| {{APITable}}
*BringItemDown (as ''boolean'') {{APIComment|Gets or sets whether this task will bring the 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 will bring the system down. '''Boolean'''.
|-
|BringItemDown||Indicates whether the task will bring the item down. '''Boolean'''.
|-
|PerformTaskEvenIfItBringsSysDown||Indicates the task should be performed if bringing the item down causes the system to go down. '''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]]''', which specifies the damage the restoration applies to (i.e., all damage or only damage since last repair).}}
|}
 


'''Additional Costs to Consider'''
'''Additional Costs to Consider'''
*MiscCostModelID (as ''integer'') {{APIComment|Gets the numerical ID model that represents the task's Cost Per Task.}}
{| {{APITable}}
*MiscCostPerTimeModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the task's Downtime Rate.}}
|-
| style="width: 240px;"|MiscCostModelID||Gets the numerical ID model that represents the task's Cost Per Task. '''Integer'''.
|-
|MiscCostPerTimeModelID||Gets the numeric ID of the model that represents the task's downtime rate. '''Integer'''.
|}


== Methods ==


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

Revision as of 21:50, 10 August 2015

Template:InProgress

APIWiki.png


Member of: SynthesisAPI


Represents a corrective task resource.

Constructors

Name Description
CCorrectiveTask Creates an instance of the cCorrectiveTask class.
cCorrectiveTask() A parameterized constructor for the cCorrectiveTask class. (.NET only)
GetCrewIDs
SetCrewIDs


Properties

Name Description
Name Gets or sets the name of the task. String.
ID Gets the numeric ID of the task. Integer
ProjectID Gets the numeric ID of the project the task belongs to. Integer.


Task Scheduling

Name Description
TaskFrequencyID Gets or sets a value from the TaskFrequencyEnum, which specifies frequency with which the task is performed.


Basic Repair Properties

Name Description
CrewIDs Gets the IDs of the crews assigned to the resource. Integer.
DurationModelID Gets the ID of the task duration model assigned to the resource. Integer.
PoolID Gets the ID of the pools assigned to the resource. Integer.


Task Consequences

Name Description
BringSystemDown Indicates whether the task will bring the system down. Boolean.
BringItemDown Indicates whether the task will bring the item down. Boolean.
PerformTaskEvenIfItBringsSysDown Indicates the task should be performed if bringing the item down causes the system to go down. 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, which specifies the damage the restoration applies to (i.e., all damage or only damage 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 numeric ID of the model that represents the task's downtime rate. Integer.


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=CCorrectiveTask_Class&oldid=60300"