CPool Class: Difference between revisions

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


{{Template:ResourceLinkToRepositoryClass.Cmt}}
== Constructors ==
*cPool {{APIComment|Creates a new pool resource.}}


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


'''Spares'''
'''Spares'''
*DirectCostModelID (as ''integer'') {{APIComment|Gets or sets the numerical ID of the model that represents the pool's direct cost per dispensed item.}}
{| {{APITable}}
*IndirectCostModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition.}}
|-
*SparesLimit (as ''integer'') {{APIComment|Gets the pool's initial stock level.}}
| style="width: 240px;"|DirectCostModelID||Gets or sets the numerical ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''.
*SparesLimitVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's spares limit variable.}}
|-
*DelayModelID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's delay model.}}
|IndirectCostModelID||Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition. '''Integer'''.
*UseFixedProbability (as ''boolean'') {{APIComment|Gets or sets whether fixed probability should be used as a spare acquisition type.}}
|-
*UseFixedProbabilityValue (as ''double'') {{APIComment|Gets a fixed probability value for the pool.}}
|SparesLimit||Gets the pool's initial stock level. '''Integer'''.
|-
|SparesLimitVariableID||Gets the numerical ID of the pool's spares limit variable. '''Integer'''.
|-
|DelayModelID||Gets the numerical ID of the pool's delay model. '''Integer'''.
|-
|UseFixedProbability||Indicates whether fixed probability should be used as a spare acquisition type. '''Boolean'''.
|-
|UseFixedProbabilityValue||Gets a fixed probability value for the pool. '''Double'''.
|}
 


'''Pool Restock Properties'''
'''Pool Restock Properties'''
*RestockOn (as ''integer'') {{APIComment|Gets the pool's RestockOn number (0 &#61; no restock, 1 &#61; scheduled restock, 2 &#61; restock as needed, 3 &#61; both 1 and 2).}}
{| {{APITable}}
*RestockEvery (as ''double'') {{APIComment|Gets or sets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}}
|-
*RestockEveryUnit (as ''integer'') {{APIComment|Gets or sets the units of measurement for the RestockEvery property (1 &#61; the first unit of measurement in the repository).}}
| style="width: 240px;"|RestockOn||Gets the pool's RestockOn number (0 &#61; no restock, 1 &#61; scheduled restock, 2 &#61; restock as needed, 3 &#61; both 1 and 2). '''Integer'''.
*RestockEveryVariableID (as ''integer'') {{APIComment|Gets the numerical ID of pool's "Restock every" variable.}}
|-
*RestockAddNumber1 (as ''integer'') {{APIComment|Gets the number added per restock for scheduled restocking.}}
|RestockEvery||Gets or sets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property. '''Double'''.
*RestockAddNumber1VariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the number added per restock for scheduled restocking.}}
|-
*RestockWhen (as ''integer'') {{APIComment|Gets the pool's "Restock when stock drops to" value.}}
|RestockEveryUnit||Gets or sets the units of measurement for the RestockEvery property (1 &#61; the first unit of measurement in the repository). '''Integer'''.
*RestockWhenVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the pool's "Restock when stock drops to" value.}}
|-
*RestockAddNumber2 (as ''integer'') {{APIComment|Gets the number added per restock for as-needed restocking.}}
|RestockEveryVariableID||Gets the numerical ID of pool's "Restock every" variable. '''Integer'''.
*RestockAddNumber2VariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the number added per restock for as-needed restocking.}}
|-
*RestockModelID (as ''integer'') {{APIComment|Gets the  numerical ID of the pool's restock model.}}
|RestockAddNumber1||Gets the number added per restock for scheduled restocking. '''Integer'''.
*HasMaxCapacity (as ''boolean'') {{APIComment|Gets or sets whether the pool has a maximum capacity.}}
|-
*MaxCapacity (as ''integer'') {{APIComment|Gets or sets the pool's maximum capacity.}}
|RestockAddNumber1VariableID||Gets the numerical ID of the variable that represents the number added per restock for scheduled restocking. '''Integer'''.
*MaxCapacityVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the pool's maximum capacity.}}
|-
|RestockWhen||Gets the pool's "Restock when stock drops to" value. '''Integer'''.
|-
|RestockWhenVariableID||Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. '''Integer'''.
|-
|RestockAddNumber2||Gets the number added per restock for as-needed restocking. '''Integer'''.
|-
|RestockAddNumber2VariableID||Gets the numeric ID of the variable that represents the number added per restock for as-needed restocking. '''Integer'''.
|-
|RestockModelID||Gets the  numerical ID of the pool's restock model. '''Integer'''.
|-
|HasMaxCapacity||Gets or sets whether the pool has a maximum capacity. '''Boolean'''.
|-
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''.
|-
|MaxCapacityVariableID||Gets the numeric ID of the variable that represents the pool's maximum capacity. '''Integer'''.
|}
 


'''Emergency Spare Provisions'''
'''Emergency Spare Provisions'''
*CanObtainEmerg (as ''boolean'') {{APIComment|Gets or sets whether emergency spares can be obtained if needed.}}
{| {{APITable}}
*EmergAddNumber (as ''integer'') {{APIComment|Gets the number of spares added per emergency.}}
|-
*EmergAddNumberVariableID  (as ''integer'') {{APIComment|Gets the numerical ID variable that represents the number of spares added per emergency..}}
| style="width: 240px;"|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''.
*EmergAddCostModelID  (as ''integer'') {{APIComment|Gets the numerical ID of model that represents the additional costs for emergency spares.}}
|-
*EmergModelID  (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the required time for emergency spares.}}
|EmergAddNumber||Gets the number of spares added per emergency. '''Integer'''.
*OffSitePoolRegularID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the off-site spare part pool under the emergency spare provisions.}}
|-
*OffSitePoolEmergencyID  (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions.}}
|EmergAddNumberVariableID||Gets the numerical ID variable that represents the number of spares added per emergency. '''Integer'''.
|-
|EmergAddCostModelID||Gets the numerical ID of model that represents the additional costs for emergency spares. '''Integer'''.
|-
|EmergModelID||Gets the numerical ID of the model that represents the required time for emergency spares. '''Integer'''.
|-
|OffSitePoolRegularID||Gets the numerical ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''.
|-
|OffSitePoolEmergencyID||Gets the numerical ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. '''Integer'''.
|}
 


'''Synthesis Identifiers'''
{| {{APITable}}
|-
| style="width: 240px;"|{{Template:API_TxtIdentifiers}}
|}


== Methods ==
== Methods ==

Revision as of 17:18, 11 August 2015

Template:InProgress

APIWiki.png


Member of: SynthesisAPI


Represents a spare part pool resource.

Constructors

Name Description
cPool Creates an instance of the cPool class.
cPool() A parameterized constructor for the cPool class. (.NET only)


Properties

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


Spares

Name Description
DirectCostModelID Gets or sets the numerical ID of the model that represents the pool's direct cost per dispensed item. Integer.
IndirectCostModelID Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition. Integer.
SparesLimit Gets the pool's initial stock level. Integer.
SparesLimitVariableID Gets the numerical ID of the pool's spares limit variable. Integer.
DelayModelID Gets the numerical ID of the pool's delay model. Integer.
UseFixedProbability Indicates whether fixed probability should be used as a spare acquisition type. Boolean.
UseFixedProbabilityValue Gets a fixed probability value for the pool. Double.


Pool Restock Properties

Name Description
RestockOn Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2). Integer.
RestockEvery Gets or sets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property. Double.
RestockEveryUnit Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement in the repository). Integer.
RestockEveryVariableID Gets the numerical ID of pool's "Restock every" variable. Integer.
RestockAddNumber1 Gets the number added per restock for scheduled restocking. Integer.
RestockAddNumber1VariableID Gets the numerical ID of the variable that represents the number added per restock for scheduled restocking. Integer.
RestockWhen Gets the pool's "Restock when stock drops to" value. Integer.
RestockWhenVariableID Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. Integer.
RestockAddNumber2 Gets the number added per restock for as-needed restocking. Integer.
RestockAddNumber2VariableID Gets the numeric ID of the variable that represents the number added per restock for as-needed restocking. Integer.
RestockModelID Gets the numerical ID of the pool's restock model. Integer.
HasMaxCapacity Gets or sets whether the pool has a maximum capacity. Boolean.
MaxCapacity Gets or sets the pool's maximum capacity. Integer.
MaxCapacityVariableID Gets the numeric ID of the variable that represents the pool's maximum capacity. Integer.


Emergency Spare Provisions

Name Description
CanObtainEmerg Indicates whether emergency spares can be obtained if needed. Boolean.
EmergAddNumber Gets the number of spares added per emergency. Integer.
EmergAddNumberVariableID Gets the numerical ID variable that represents the number of spares added per emergency. Integer.
EmergAddCostModelID Gets the numerical ID of model that represents the additional costs for emergency spares. Integer.
EmergModelID Gets the numerical ID of the model that represents the required time for emergency spares. Integer.
OffSitePoolRegularID Gets the numerical ID of the model that represents the off-site spare part pool under the emergency spare provisions. Integer.
OffSitePoolEmergencyID Gets the numerical ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. 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

Methods

Set/Return Item Properties

Retrieved from "https://www.reliawiki.com/index.php?title=CPool_Class&oldid=60328"