CPool Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|CPool Class|CPool}}  
{{DISPLAYTITLE:cPool Class}}{{Template:API}}{{Template:APIBreadcrumb}}


Spare part pools are assigned to tasks. They are used to describe the conditions that determine whether a spare part will be available when needed and to specify the time and costs associated with obtaining the spare part.


=== Constructors ===
<onlyinclude>Represents a spare part pool resource.</onlyinclude>


*'''[[New cPool]]''' {{APIComment|Creates a new instance of the resource.}}
==Constructors==
{| {{APITable}}
|-
| style="width: 240px;"|cPool||Creates an instance of the cPool class.  
|-
|[[CPool Constructors|cPool()]]||{{:CPool Constructors}}
|}


=== Properties  ===
 
*'''[[cPool.Name|Name]]''' {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
== Properties  ==
*'''[[cPool.ID|ID]]''' {{APIComment|Returns the ID of the resource (the one used in the repository).}}
{| {{APITable}}
*'''[[cPool.ProjectID|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}}
|-
*'''[[cPool.DirectCostModelID|DirectCostModelID]]''' {{APIComment|Sets or returns the direct cost model ID the resource belongs to.}}
| style="width: 240px;"|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''. Default value = False.
*'''[[cPool.IndirectCostModelID|IndirectCostModelID]]''' {{APIComment|Returns the indirect cost model ID the resource belongs to.}}
|-
*'''[[cPool.SparesLimit|SparesLimit]]''' {{APIComment|Returns the spares limit ID the resource belongs to.}}
|DelayModelID||Gets or sets the numeric ID of model that represents the pool's logistic time for spare acquisition. '''Integer'''.
*'''[[cPool.SparesLimitVariableID|SparesLimitVariableID]]''' {{APIComment|Returns the ID of the spares limit variable the resource belongs to.}}
|-
*'''[[cPool.DelayModelID|DelayModelID]]''' {{APIComment|Returns the ID of the delay model the resource belongs to.}}
|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''.
*'''[[cPool.UseFixedProbability|UseFixedProbability]]''' {{APIComment|Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.}}
|-
*'''[[cPool.FixedProbabilityValue|UseFixedProbabilityValue]]''' {{APIComment|Returns a fixed probability value for the resource.}}
|EmergAddCostModelID||Gets or sets the numeric ID of the model that represents the additional costs for emergency spares. '''Integer'''.
*'''[[cPool.RestockOn|RestockOn]]''' {{APIComment|Returns the Restock number the resource belongs to.}}
|-
*'''[[cPool.RestockEvery|RestockEvery]]''' {{APIComment|Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}}
|EmergAddNumber||Gets or sets the number of spares added per emergency. '''Integer'''. Default value = 1.
*'''[[cPool.RestockEveryUnit|RestockEveryUnit]]''' {{APIComment|Sets or returns temporal units for RestockEvery Property for the resource belonged to.}}
|-
*'''[[cPool.RestockEveryVariableID|RestockEveryVariableID]]''' {{APIComment|Returns the ID of RestockEveryVariable the resource belongs to.}}
|EmergAddNumberVariableID||Gets or sets the numeric ID of the variable that represents the number of spares added per emergency. '''Integer'''.
*'''[[cPool.RestockAddNumber1|RestockAddNumber1]]''' {{APIComment|Returns a restock value of 1 for the resource.}}
|-
*'''[[cPool.RestockAddNumber1VariableID|RestockAddNumber1VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber1 the resource belongs to.}}
|EmergModelID||Gets or sets the numeric ID of the model that represents the required time for emergency spares. '''Integer'''.
*'''[[cPool.RestockWhen|RestockWhen]]''' {{APIComment|Returns the value that restock is needed at when stock drops to that value within the resource belonged to.}}
|-
*'''[[cPool.RestockWhenVariableID|RestockWhenVariableID]]''' {{APIComment|Returns the ID of the Restock when set variable ID the resource belongs to.}}
|FixedProbabilityValue||Gets or sets the fixed probability of stockout for the pool. '''Double'''. Applies only when the UseFixedProbability property is set to true. Default value = 0.1.
*'''[[cPool.RestockAddNumber2|RestockAddNumber2]]''' {{APIComment|Returns the RestockAddNumber2 the resource belongs to.}}
|-
*'''[[cPool.RestockAddNumber2VariableID|RestockAddNumber2VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber2 Variable the resource belongs to.}}
|HasMaxCapacity||Indicates whether the pool has a maximum capacity. '''Boolean'''. Applies only when the pool has a limited number of spares. Default value = False.
*'''[[cPool.RestockModelID|RestockModelID]]''' {{APIComment|Returns the ID of the restock model the resource belongs to.}}
|-
*'''[[cPool.HasMaxCapacity|HasMaxCapacity]]''' {{APIComment|Sets or returns whether a pool has maximum capacity for the resource belonged to.}}
|ID||Gets the numeric ID of the spare part pool. '''Integer'''.
*'''[[cPool.MaxCapacity|MaxCapacity]]''' {{APIComment|Sets or returns the maximum capacity the resource belongs to.}}
|-
*'''[[cPool.MaxCapacityVariableID|MaxCapacityVariableID]]''' {{APIComment|Returns the ID of the maximum capacity variable the resource belongs to.}}
|IndirectCostModelID||Gets or sets the numeric ID of the model that represents the spare's holding cost ($/Hr in pool). '''Integer'''.
*'''[[cPool.CanObtainEmerg|CanObtainEmerg]]''' {{APIComment|Sets or returns whether emergency spares can be obtained for the resource belonged to.}}
|-
*'''[[cPool.EmergAddNumber|EmergAddNumber]]''' {{APIComment|Returns the number of spares added per emergency the resource belongs to.}}
|{{Template:API_TxtIdentifiers}}
*'''[[cPool.EmergAddNumberVariableID|EmergAddNumberVariableID ]]''' {{APIComment|Returns the ID of the EmergAddNumber variable for which the resource belongs to.}}
|-
*'''[[cPool.EmergAddCostModelID|EmergAddCostModelID ]]''' {{APIComment|Returns the ID of EmergAddCostModel for which the resource belongs to.}}
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''. Applies only when the pool has a limited number of spares. Default value = 3.
*'''[[cPool.EmergModelID|EmergModelID ]]''' {{APIComment|Returns the ID of EmergModel for which the resource belongs to.}}
|-
*'''[[cPool.OffSitePoolRegularID|OffSitePoolRegularID]]''' {{APIComment|Returns the ID of OffSitePoolRegular for which the resource belongs to.}}
|MaxCapacityVariableID||Gets or sets the numeric ID of the variable that represents the pool's maximum capacity. '''Integer'''. Applies only when the pool has a limited number of spares.
*'''[[cPool.OffSitePoolEmergencyID|OffSitePoolEmergencyID ]]''' {{APIComment|Returns the ID of OffSitePoolEmergency for which the resource belongs to.}}
|-
|Name||Gets or sets the name of the spare part pool. '''String'''.
|-
|OffSitePoolEmergencyID||Gets or sets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''.
|-
|OffSitePoolRegularID||Gets or sets the numeric ID of the model that represents the off-site spare part pool for as-needed restocking. '''Integer'''.
|-
|ProjectID||Gets the numeric ID of the project the pool belongs to. '''Integer'''.
|-
|RestockAddNumber1||Gets or sets the number added per restock for scheduled restocking. '''Integer'''. Default value = 1.
|-
|RestockAddNumber1VariableID||Gets or sets the numeric ID of the variable that represents the number added per restock for scheduled restocking. '''Integer'''.
|-
|RestockAddNumber2||Gets or sets the number added per restock for as-needed restocking. '''Integer'''. Default value = 1.
|-
|RestockAddNumber2VariableID||Gets or sets the numeric ID of the variable that represents the number added per restock for as-needed restocking. '''Integer'''.
|-
|RestockEvery||Gets or sets the value for how often the pool should be restocked (for scheduled restocking). '''Double'''. Default value = 1.
|-
|RestockEveryUnit||Gets or sets the unit of measurement for the RestockEvery property (1 &#61; the first unit of measurement defined in the repository). '''Integer'''.
|-
|RestockEveryVariableID||Gets or sets the numeric ID of the variable that represents the frequency with which the pool should be restocked (for scheduled restocking). '''Integer'''.
|-
|RestockModelID||Gets or sets the numeric ID of the model that represents the time required for stock arrival in as needed restocking. '''Integer'''.
|-
|RestockOn||Gets or sets a value from the [[RestockOnEnum Enumeration|RestockOnEnum]] enumeration, which specifies the pool's restock schedule (e.g. restock as needed, restock as scheduled, etc.).
 
|-
|RestockWhen||Gets or sets the quantity that the stock must reach to trigger restocking (i.e., in as-needed restocking, restock when stock drops to this value). '''Integer'''.
|-
|RestockWhenVariableID||Gets or sets the numeric ID of the variable that represents the quantity that the stock must reach to trigger restocking. '''Integer'''.
|-
|SparesLimit||Gets or sets the pool's initial stock level. '''Integer'''. Default value = -1, which indicates unlimited spares.
|-
|SparesLimitVariableID||Gets or sets the numeric ID of the variable that represents the pool's initial stock level. '''Integer'''.
|-
|UseFixedProbability||Indicates whether a fixed probability should be used as a spare acquisition type. '''Boolean'''. If true, specify a value for the FixedProbabilityValue property. Default value = False.
|}
 
 
 
 
 
==See Also==
*[[Repository.Pool.AddPool|Repository.Pool.AddPool Method]]
*[[Repository.Pool.GetAllPools|Repository.Pool.GetAllPools Method]]
*[[Repository.Pool.GetPool|Repository.Pool.GetPool Method]]
*[[Repository.Pool.UpdatePool|Repository.Pool.UpdatePool Method]]

Latest revision as of 21:23, 24 June 2016

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
CanObtainEmerg Indicates whether emergency spares can be obtained if needed. Boolean. Default value = False.
DelayModelID Gets or sets the numeric ID of model that represents the pool's logistic time for spare acquisition. Integer.
DirectCostModelID Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. Integer.
EmergAddCostModelID Gets or sets the numeric ID of the model that represents the additional costs for emergency spares. Integer.
EmergAddNumber Gets or sets the number of spares added per emergency. Integer. Default value = 1.
EmergAddNumberVariableID Gets or sets the numeric ID of the variable that represents the number of spares added per emergency. Integer.
EmergModelID Gets or sets the numeric ID of the model that represents the required time for emergency spares. Integer.
FixedProbabilityValue Gets or sets the fixed probability of stockout for the pool. Double. Applies only when the UseFixedProbability property is set to true. Default value = 0.1.
HasMaxCapacity Indicates whether the pool has a maximum capacity. Boolean. Applies only when the pool has a limited number of spares. Default value = False.
ID Gets the numeric ID of the spare part pool. Integer.
IndirectCostModelID Gets or sets the numeric ID of the model that represents the spare's holding cost ($/Hr in pool). Integer.
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
MaxCapacity Gets or sets the pool's maximum capacity. Integer. Applies only when the pool has a limited number of spares. Default value = 3.
MaxCapacityVariableID Gets or sets the numeric ID of the variable that represents the pool's maximum capacity. Integer. Applies only when the pool has a limited number of spares.
Name Gets or sets the name of the spare part pool. String.
OffSitePoolEmergencyID Gets or sets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. Integer.
OffSitePoolRegularID Gets or sets the numeric ID of the model that represents the off-site spare part pool for as-needed restocking. Integer.
ProjectID Gets the numeric ID of the project the pool belongs to. Integer.
RestockAddNumber1 Gets or sets the number added per restock for scheduled restocking. Integer. Default value = 1.
RestockAddNumber1VariableID Gets or sets the numeric ID of the variable that represents the number added per restock for scheduled restocking. Integer.
RestockAddNumber2 Gets or sets the number added per restock for as-needed restocking. Integer. Default value = 1.
RestockAddNumber2VariableID Gets or sets the numeric ID of the variable that represents the number added per restock for as-needed restocking. Integer.
RestockEvery Gets or sets the value for how often the pool should be restocked (for scheduled restocking). Double. Default value = 1.
RestockEveryUnit Gets or sets the unit of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). Integer.
RestockEveryVariableID Gets or sets the numeric ID of the variable that represents the frequency with which the pool should be restocked (for scheduled restocking). Integer.
RestockModelID Gets or sets the numeric ID of the model that represents the time required for stock arrival in as needed restocking. Integer.
RestockOn Gets or sets a value from the RestockOnEnum enumeration, which specifies the pool's restock schedule (e.g. restock as needed, restock as scheduled, etc.).
RestockWhen Gets or sets the quantity that the stock must reach to trigger restocking (i.e., in as-needed restocking, restock when stock drops to this value). Integer.
RestockWhenVariableID Gets or sets the numeric ID of the variable that represents the quantity that the stock must reach to trigger restocking. Integer.
SparesLimit Gets or sets the pool's initial stock level. Integer. Default value = -1, which indicates unlimited spares.
SparesLimitVariableID Gets or sets the numeric ID of the variable that represents the pool's initial stock level. Integer.
UseFixedProbability Indicates whether a fixed probability should be used as a spare acquisition type. Boolean. If true, specify a value for the FixedProbabilityValue property. Default value = False.



See Also

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