CPool Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (Updated definition of Restock On property for V10.1) |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 16: | Line 16: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 240px;"|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''. | | style="width: 240px;"|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'''. | |DelayModelID||Gets or sets the numeric ID of model that represents the pool's logistic time for spare acquisition. '''Integer'''. | ||
| Line 24: | Line 24: | ||
|EmergAddCostModelID||Gets or sets the numeric ID of the model that represents the additional costs for emergency spares. '''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'''. | |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'''. | |EmergAddNumberVariableID||Gets or sets the numeric ID of the variable that represents the number of spares added per emergency. '''Integer'''. | ||
| Line 30: | Line 30: | ||
|EmergModelID||Gets or sets the numeric ID of the model that represents the required time for emergency spares. '''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. | |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. | |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'''. | |ID||Gets the numeric ID of the spare part pool. '''Integer'''. | ||
| Line 40: | Line 40: | ||
|{{Template:API_TxtIdentifiers}} | |{{Template:API_TxtIdentifiers}} | ||
|- | |- | ||
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''. Applies only when the pool has a limited number of spares. | |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. | |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. | ||
| Line 52: | Line 52: | ||
|ProjectID||Gets the numeric ID of the project the pool belongs to. '''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'''. | |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'''. | |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'''. | |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'''. | |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'''. | |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'''. | |RestockEveryUnit||Gets or sets the unit of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). '''Integer'''. | ||
| Line 75: | Line 75: | ||
|RestockWhenVariableID||Gets or sets the numeric ID of the variable that represents the quantity that the stock must reach to trigger restocking. '''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. | |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'''. | |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. | |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. | ||
|} | |} | ||
Revision as of 21:54, 29 April 2016
 |
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 property (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. |