CPool Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 20: | Line 20: | ||
|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''. | |CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''. | ||
|- | |- | ||
|DelayModelID||Gets or sets the numeric ID of the pool's logistic | |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 | |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 | |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'''. | ||
| Line 32: | Line 32: | ||
|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 | |FixedProbabilityValue||Gets or sets the fixed probability of stockout for the pool. '''Double'''. Applies only when the UseFixedProbability property is set to true. | ||
|- | |- | ||
|HasMaxCapacity|| | |HasMaxCapacity||Indicates whether the pool has a maximum capacity. '''Boolean'''. Applies only when the pool has a limited number of spares (SparesLimit > 0). | ||
|- | |- | ||
|IndirectCostModelID||Gets the numeric ID of the model that represents the | |IndirectCostModelID||Gets the numeric ID of the model that represents the spare's holding cost ($/Hr in pool). '''Integer'''. | ||
|- | |- | ||
|{{Template:API_TxtIdentifiers}} | |{{Template:API_TxtIdentifiers}} | ||
|- | |- | ||
|MaxCapacity|| | |MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''. Applies only when the pool has a limited number of spares (SparesLimit > 0) | ||
|- | |- | ||
|MaxCapacityVariableID|| | |MaxCapacityVariableID||Gets 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 (SparesLimit > 0) | ||
|- | |- | ||
|Name||Gets or sets the name of the spare part pool. '''String'''. | |Name||Gets or sets the name of the spare part pool. '''String'''. | ||
|- | |- | ||
|OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the | |OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''. | ||
|- | |- | ||
|OffSitePoolRegularID||Gets the numeric ID of the model that represents the off-site spare part pool | |OffSitePoolRegularID||Gets 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'''. | |ProjectID||Gets the numeric ID of the project the pool belongs to. '''Integer'''. | ||
| Line 64: | Line 64: | ||
|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'''. | ||
|- | |- | ||
|RestockEveryVariableID||Gets the numeric ID of the variable | |RestockEveryVariableID||Gets the numeric ID of the variable that represents the frequency with which the pool should be restocked (for scheduled restocking). '''Integer'''. | ||
|- | |- | ||
|RestockModelID||Gets the numeric ID of the | |RestockModelID||Gets the numeric ID of the model that represents the time required for stock arrival in as needed restocking. '''Integer'''. | ||
|- | |- | ||
|RestockOn||Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2). '''Integer'''. | |RestockOn||Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2). '''Integer'''. | ||
Revision as of 17:00, 5 October 2015
 |
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 |
|---|---|
| ID | Gets the numeric ID of the spare part pool. Integer. |
| CanObtainEmerg | Indicates whether emergency spares can be obtained if needed. Boolean. |
| 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. |
| 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. |
| HasMaxCapacity | Indicates whether the pool has a maximum capacity. Boolean. Applies only when the pool has a limited number of spares (SparesLimit > 0). |
| IndirectCostModelID | Gets 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 (SparesLimit > 0) |
| MaxCapacityVariableID | Gets 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 (SparesLimit > 0) |
| Name | Gets or sets the name of the spare part pool. String. |
| OffSitePoolEmergencyID | Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. Integer. |
| OffSitePoolRegularID | Gets 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 the number added per restock for scheduled restocking. Integer. |
| RestockAddNumber1VariableID | Gets the numeric ID of the variable that represents the number added per restock for scheduled restocking. 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. |
| RestockEvery | Gets or sets the value for how often the pool should be restocked (for scheduled restocking). Double. |
| 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 the numeric ID of the variable that represents the frequency with which the pool should be restocked (for scheduled restocking). Integer. |
| RestockModelID | Gets the numeric ID of the model that represents the time required for stock arrival in as needed restocking. Integer. |
| RestockOn | Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2). Integer. |
| RestockWhen | Gets the pool's "Restock when stock drops to" value (as needed restocking). Integer. |
| RestockWhenVariableID | Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. Integer. |
| SparesLimit | Gets the pool's initial stock level. A value of zero (0) indicates unlimited spares. Integer. |
| SparesLimitVariableID | Gets the numeric ID of the pool's spares limit variable. 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. |