CPool Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 16: Line 16:
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 240px;"|Name||Gets or sets the name of the spare part pool. '''String'''.
| style="width: 240px;"|ID||Gets the numeric ID of the spare part pool. '''Integer'''.
|-
|-
|ID||Gets the numeric ID of the spare part pool. '''Integer'''.
|{{Template:API_TxtIdentifiers}}
|-
|Name||Gets or sets the name of the spare part pool. '''String'''.
|-
|-
|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'''.
|}
'''Spares'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|DelayModelID||Gets the numeric ID of the pool's delay model. '''Integer'''.
|-
|DirectCostModelID||Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. '''Integer'''.
|-
|FixedProbabilityValue||Gets a fixed probability value for the pool. '''Double'''.
|-
|-
|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'''.
Line 34: Line 37:
|-
|-
|SparesLimitVariableID||Gets the numeric ID of the pool's spares limit variable. '''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'''.
|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'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|}
 
 
'''Pool Restock Properties'''
{| {{APITable}}
|-
|-
| 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'''.
|HasMaxCapacity||Indicates whether the pool has a maximum capacity. '''Boolean'''.
|-
|-
|RestockEvery||Gets or sets the value for how often the pool should be restocked. '''Double'''.
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''.
|-
|-
|RestockEveryUnit||Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). '''Integer'''.
|MaxCapacityVariableID||Gets the numeric ID of the variable that represents the pool's maximum capacity. '''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'''.
Line 58: Line 52:
|RestockAddNumber1VariableID||Gets the numeric ID of the variable that represents 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'''.
|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'''.
|-
|-
|RestockWhenVariableID||Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. '''Integer'''.
|RestockEvery||Gets or sets the value for how often the pool should be restocked. '''Double'''.
|-
|-
|RestockAddNumber2||Gets the number added per restock for as-needed restocking. '''Integer'''.
|RestockEveryUnit||Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement defined in the repository). '''Integer'''.
|-
|-
|RestockAddNumber2VariableID||Gets the numeric ID of the variable that represents the number added per restock for as-needed restocking. '''Integer'''.
|RestockEveryVariableID||Gets the numeric ID of the pool's "Restock every" variable. '''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'''.
|-
|-
|HasMaxCapacity||Indicates whether the pool has a maximum capacity. '''Boolean'''.
|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'''.
|-
|RestockWhenVariableID||Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. '''Integer'''.
|-
|-
|MaxCapacity||Gets or sets the pool's maximum capacity. '''Integer'''.
| style="border-bottom:1pt solid #585858; color:#585858;"|
|-
|-
|MaxCapacityVariableID||Gets the numeric ID of the variable that represents the pool's maximum capacity. '''Integer'''.
|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''.
|}
 
 
'''Emergency Spare Provisions'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|CanObtainEmerg||Indicates whether emergency spares can be obtained if needed. '''Boolean'''.
|EmergAddCostModelID||Gets the numeric ID of the model that represents the additional costs for emergency spares. '''Integer'''.
|-
|-
|EmergAddNumber||Gets the number of spares added per emergency. '''Integer'''.
|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'''.
|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'''.
|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'''.
|OffSitePoolEmergencyID||Gets the numeric ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions. '''Integer'''.
|}
'''Synthesis Identifiers'''
{| {{APITable}}
|-
|-
| style="width: 240px;"|{{Template:API_TxtIdentifiers}}
|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 18:17, 31 August 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.
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
Name Gets or sets the name of the spare part pool. String.
ProjectID Gets the numeric ID of the project the pool belongs to. Integer.
DelayModelID Gets the numeric ID of the pool's delay model. Integer.
DirectCostModelID Gets or sets the numeric ID of the model that represents the pool's direct cost per dispensed item. Integer.
FixedProbabilityValue Gets a fixed probability value for the pool. Double.
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.
UseFixedProbability Indicates whether a fixed probability should be used as a spare acquisition type. Boolean.
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.
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. 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 numeric ID of the pool's "Restock every" variable. 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. Integer.
RestockWhenVariableID Gets the numeric ID of the variable that represents the pool's "Restock when stock drops to" value. Integer.
CanObtainEmerg Indicates whether emergency spares can be obtained if needed. Boolean.
EmergAddCostModelID Gets the numeric ID of the model that represents the additional costs for emergency spares. Integer.
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.