CPool Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 18: Line 18:
| style="width: 240px;"|ID||Gets the numeric ID of the spare part pool. '''Integer'''.
| style="width: 240px;"|ID||Gets the numeric ID of the spare part pool. '''Integer'''.
|-
|-
|{{Template:API_TxtIdentifiers}}
|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''.
|-
|DelayModelID||Gets or sets the numeric ID of the pool's logistic delay model. A value of zero indicates immediate availability of spares or that the model does not exist. '''Integer'''.
|-
|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. A value of zero indicates no cost or that the model does not exist. '''Integer'''.
|-
|-
|Name||Gets or sets the name of the spare part pool. '''String'''.
|EmergAddCostModelID||Gets or sets the numeric ID of the model that represents the additional costs for emergency spares. A value of zero indicates no cost or that the model does not exist. '''Integer'''.
|-
|-
|ProjectID||Gets the numeric ID of the project the pool belongs to. '''Integer'''.
|EmergAddNumber||Gets or sets the number of spares added per emergency. '''Integer'''.
|-
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
|EmergAddNumberVariableID||Gets or sets the numeric ID of the variable that represents the number of spares added per emergency. '''Integer'''.
|-
|-
|DelayModelID||Gets the numeric ID of the pool's logistic delay model. '''Integer'''.
|EmergModelID||Gets or sets the numeric ID of the model that represents the required time for emergency spares. '''Integer'''.
|-
|-
|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''.
|FixedProbabilityValue||Gets or sets a fixed probability of stockout for the pool. '''Double'''.
|-
|-
|FixedProbabilityValue||Applies only if the UseFixedProbability property is true. Gets a fixed probability of stockout for the pool. '''Double'''.
|HasMaxCapacity||Applies only if the value of SparesLimit is greater than zero (0). Indicates whether the pool has a maximum capacity. '''Boolean'''.
|-
|-
|IndirectCostModelID||Gets the numeric ID of the model that represents the pool's logistic time for spare acquisition. '''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. A value of zero (0) indicates unlimited spares. '''Integer'''.
|{{Template:API_TxtIdentifiers}}
|-
|-
|SparesLimitVariableID||Gets the numeric ID of the pool's spares limit variable. '''Integer'''.
|MaxCapacity||Applies only if the value of SparesLimit is greater than zero (0). Gets or sets the pool's maximum capacity. '''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.
|MaxCapacityVariableID||Applies only if the value of SparesLimit is greater than zero (0). Gets the numeric ID of the variable that represents the pool's maximum capacity. '''Integer'''.
|-
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
|Name||Gets or sets the name of the spare part pool. '''String'''.
|-
|-
|HasMaxCapacity||Applies only if the value of SparesLimit is greater than zero (0). Indicates whether the pool has a maximum capacity. '''Boolean'''.
|OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. '''Integer'''.
|-
|-
|MaxCapacity||Applies only if the value of SparesLimit is greater than zero (0). Gets or sets the pool's maximum capacity. '''Integer'''.
|OffSitePoolRegularID||Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''.
|-
|-
|MaxCapacityVariableID||Applies only if the value of SparesLimit is greater than zero (0). Gets the numeric ID of the variable that represents the pool's maximum capacity. '''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'''.
|RestockAddNumber1||Gets the number added per restock for scheduled restocking. '''Integer'''.
Line 58: Line 62:
|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'''.
|-
|-
|RestockEveryUnit||Gets or sets the units 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 pool's "Restock every" variable. '''Integer'''.
|RestockEveryVariableID||Gets the numeric ID of the variable used in the RestockEvery property. '''Integer'''.
|-
|-
|RestockModelID||Gets the numeric ID of the pool's restock model. '''Integer'''.
|RestockModelID||Gets the numeric ID of the pool's restock model. '''Integer'''.
Line 66: Line 70:
|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'''.
|-
|-
|RestockWhen||Gets the pool's "Restock when stock drops to" value. '''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'''.
|RestockWhenVariableID||Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. '''Integer'''.
|-
|-
| style="border-bottom:1pt solid #585858; color:#585858;"|
|SparesLimit||Gets the pool's initial stock level. A value of zero (0) indicates unlimited spares. '''Integer'''.
|-
|-
|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''.
|SparesLimitVariableID||Gets the numeric ID of the pool's spares limit variable. '''Integer'''.
|-
|-
|EmergAddCostModelID||Gets the numeric ID of the model that represents the additional costs for emergency spares. '''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.
|-
|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'''.
|-
|EmergModelID||Gets the numeric ID of the model that represents the required time for emergency spares. '''Integer'''.
|-
|OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. '''Integer'''.
|-
|OffSitePoolRegularID||Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. '''Integer'''.
|}
|}

Revision as of 21:27, 2 October 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
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 the pool's logistic delay model. A value of zero indicates immediate availability of spares or that the model does not exist. Integer.
DirectCostModelID Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. A value of zero indicates no cost or that the model does not exist. Integer.
EmergAddCostModelID Gets or sets the numeric ID of the model that represents the additional costs for emergency spares. A value of zero indicates no cost or that the model does not exist. 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 a fixed probability of stockout for the pool. Double.
HasMaxCapacity Applies only if the value of SparesLimit is greater than zero (0). Indicates whether the pool has a maximum capacity. Boolean.
IndirectCostModelID Gets the numeric ID of the model that represents the pool's logistic time for spare acquisition. 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 Applies only if the value of SparesLimit is greater than zero (0). Gets or sets the pool's maximum capacity. Integer.
MaxCapacityVariableID Applies only if the value of SparesLimit is greater than zero (0). Gets the numeric ID of the variable that represents the pool's maximum capacity. Integer.
Name Gets or sets the name of the spare part pool. String.
OffSitePoolEmergencyID Gets the numeric ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. Integer.
OffSitePoolRegularID Gets the numeric ID of the model that represents the off-site spare part pool under the emergency spare provisions. 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 used in the RestockEvery property. Integer.
RestockModelID Gets the numeric ID of the pool's restock model. 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.