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 27: | Line 27: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 240px;"|DirectCostModelID||Gets or sets the | | style="width: 240px;"|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''. | ||
|- | |- | ||
|IndirectCostModelID||Gets the | |IndirectCostModelID||Gets the numeric ID of the model that represents the pool's logistic time for spare acquisition. '''Integer'''. | ||
|- | |- | ||
|SparesLimit||Gets the pool's initial stock level. '''Integer'''. | |SparesLimit||Gets the pool's initial stock level. '''Integer'''. | ||
|- | |- | ||
|SparesLimitVariableID||Gets the | |SparesLimitVariableID||Gets the numeric ID of the pool's spares limit variable. '''Integer'''. | ||
|- | |- | ||
|DelayModelID||Gets the | |DelayModelID||Gets the numeric ID of the pool's delay model. '''Integer'''. | ||
|- | |- | ||
|UseFixedProbability||Indicates whether fixed probability should be used as a spare acquisition type. '''Boolean'''. | |UseFixedProbability||Indicates whether a fixed probability should be used as a spare acquisition type. '''Boolean'''. | ||
|- | |- | ||
| | |FixedProbabilityValue||Gets a fixed probability value for the pool. '''Double'''. | ||
|} | |} | ||
| Line 48: | Line 48: | ||
| style="width: 240px;"|RestockOn||Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2). '''Integer'''. | | style="width: 240px;"|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 | |RestockEvery||Gets or sets the value for how often the pool should be restocked. '''Double'''. | ||
|- | |- | ||
|RestockEveryUnit||Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement in the repository). '''Integer'''. | |RestockEveryUnit||Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). '''Integer'''. | ||
|- | |- | ||
|RestockEveryVariableID||Gets the numerical ID of pool's "Restock every" variable. '''Integer'''. | |RestockEveryVariableID||Gets the numerical ID of the pool's "Restock every" variable. '''Integer'''. | ||
|- | |- | ||
|RestockAddNumber1||Gets the number added per restock for scheduled restocking. '''Integer'''. | |RestockAddNumber1||Gets the number added per restock for scheduled restocking. '''Integer'''. | ||
|- | |- | ||
|RestockAddNumber1VariableID||Gets the | |RestockAddNumber1VariableID||Gets the numeric 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'''. | |RestockWhen||Gets the pool's "Restock when stock drops to" value. '''Integer'''. | ||
| Line 66: | Line 66: | ||
|RestockAddNumber2VariableID||Gets the numeric ID of the variable that represents 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 | |RestockModelID||Gets the numeric ID of the pool's restock model. '''Integer'''. | ||
|- | |- | ||
|HasMaxCapacity|| | |HasMaxCapacity||Indicates whether the pool has a maximum capacity. '''Boolean'''. | ||
|- | |- | ||
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''. | |MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''. | ||
| Line 83: | Line 83: | ||
|EmergAddNumber||Gets the number of spares added per emergency. '''Integer'''. | |EmergAddNumber||Gets the number of spares added per emergency. '''Integer'''. | ||
|- | |- | ||
|EmergAddNumberVariableID||Gets the | |EmergAddNumberVariableID||Gets the numeric ID of the variable that represents the number of spares added per emergency. '''Integer'''. | ||
|- | |- | ||
|EmergAddCostModelID||Gets the | |EmergAddCostModelID||Gets the numeric ID of the model that represents the additional costs for emergency spares. '''Integer'''. | ||
|- | |- | ||
|EmergModelID||Gets the | |EmergModelID||Gets the numeric ID of the model that represents the required time for emergency spares. '''Integer'''. | ||
|- | |- | ||
|OffSitePoolRegularID||Gets the | |OffSitePoolRegularID||Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''. | ||
|- | |- | ||
|OffSitePoolEmergencyID||Gets the | |OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. '''Integer'''. | ||
|} | |} | ||
Revision as of 18:52, 11 August 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 |
|---|---|
| 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 numeric ID of the model that represents the pool's direct cost per dispensed item. Integer. |
| IndirectCostModelID | Gets the numeric 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 numeric ID of the pool's spares limit variable. Integer. |
| DelayModelID | Gets the numeric ID of the pool's delay model. Integer. |
| UseFixedProbability | Indicates whether a fixed probability should be used as a spare acquisition type. Boolean. |
| FixedProbabilityValue | 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 the pool should be restocked. Double. |
| RestockEveryUnit | Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). Integer. |
| RestockEveryVariableID | Gets the numerical ID of the pool's "Restock every" variable. 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. |
| 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 numeric ID of the pool's restock model. Integer. |
| HasMaxCapacity | Indicates 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 numeric ID of the variable that represents the number of spares added per emergency. Integer. |
| EmergAddCostModelID | Gets the numeric ID of the model that represents the additional costs for emergency spares. Integer. |
| EmergModelID | Gets the numeric ID of the model that represents the required time for emergency spares. Integer. |
| OffSitePoolRegularID | Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. Integer. |
| OffSitePoolEmergencyID | Gets the numeric 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 |