CPool Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) |
Chris Kahn (talk | contribs) No edit summary |
||
Line 8: | Line 8: | ||
== Properties == | == Properties == | ||
'''Pool''' | '''Pool''' | ||
*Name (as ''string'') {{APIComment| | *Name (as ''string'') {{APIComment|Gets or sets the name of the pool.}} | ||
*ID (as ''integer'') {{APIComment|Gets the numerical ID of the pool.}} | *ID (as ''integer'') {{APIComment|Gets the numerical ID of the pool.}} | ||
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the pool belongs to.}} | *ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the pool belongs to.}} | ||
'''Spares''' | '''Spares''' | ||
*DirectCostModelID (as ''integer'') {{APIComment| | *DirectCostModelID (as ''integer'') {{APIComment|Gets or sets the numerical ID of the model that represents the pool's direct cost per dispensed item.}} | ||
*IndirectCostModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition.}} | *IndirectCostModelID (as ''integer'') {{APIComment|Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition.}} | ||
*SparesLimit (as ''integer'') {{APIComment|Gets the pool's initial stock level.}} | *SparesLimit (as ''integer'') {{APIComment|Gets the pool's initial stock level.}} | ||
*SparesLimitVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's spares limit variable.}} | *SparesLimitVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's spares limit variable.}} | ||
*DelayModelID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's delay model.}} | *DelayModelID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's delay model.}} | ||
*UseFixedProbability (as ''boolean'') {{APIComment| | *UseFixedProbability (as ''boolean'') {{APIComment|Gets or sets whether fixed probability should be used as a spare acquisition type.}} | ||
*UseFixedProbabilityValue (as ''double'') {{APIComment|Gets a fixed probability value for the pool.}} | *UseFixedProbabilityValue (as ''double'') {{APIComment|Gets a fixed probability value for the pool.}} | ||
'''Pool Restock Properties''' | '''Pool Restock Properties''' | ||
*RestockOn (as ''integer'') {{APIComment|Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2).}} | *RestockOn (as ''integer'') {{APIComment|Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2).}} | ||
*RestockEvery (as ''double'') {{APIComment| | *RestockEvery (as ''double'') {{APIComment|Gets or sets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}} | ||
*RestockEveryUnit (as ''integer'') {{APIComment| | *RestockEveryUnit (as ''integer'') {{APIComment|Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement in the repository).}} | ||
*RestockEveryVariableID (as ''integer'') {{APIComment|Gets the numerical ID of pool's "Restock every" variable.}} | *RestockEveryVariableID (as ''integer'') {{APIComment|Gets the numerical ID of pool's "Restock every" variable.}} | ||
*RestockAddNumber1 (as ''integer'') {{APIComment|Gets the number added per restock for scheduled restocking.}} | *RestockAddNumber1 (as ''integer'') {{APIComment|Gets the number added per restock for scheduled restocking.}} | ||
Line 33: | Line 33: | ||
*RestockAddNumber2VariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the number added per restock for as-needed restocking.}} | *RestockAddNumber2VariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the number added per restock for as-needed restocking.}} | ||
*RestockModelID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's restock model.}} | *RestockModelID (as ''integer'') {{APIComment|Gets the numerical ID of the pool's restock model.}} | ||
*HasMaxCapacity (as ''boolean'') {{APIComment| | *HasMaxCapacity (as ''boolean'') {{APIComment|Gets or sets whether the pool has a maximum capacity.}} | ||
*MaxCapacity (as ''integer'') {{APIComment| | *MaxCapacity (as ''integer'') {{APIComment|Gets or sets the pool's maximum capacity.}} | ||
*MaxCapacityVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the pool's maximum capacity.}} | *MaxCapacityVariableID (as ''integer'') {{APIComment|Gets the numerical ID of the variable that represents the pool's maximum capacity.}} | ||
'''Emergency Spare Provisions''' | '''Emergency Spare Provisions''' | ||
*CanObtainEmerg (as ''boolean'') {{APIComment| | *CanObtainEmerg (as ''boolean'') {{APIComment|Gets or sets whether emergency spares can be obtained if needed.}} | ||
*EmergAddNumber (as ''integer'') {{APIComment|Gets the number of spares added per emergency.}} | *EmergAddNumber (as ''integer'') {{APIComment|Gets the number of spares added per emergency.}} | ||
*EmergAddNumberVariableID (as ''integer'') {{APIComment|Gets the numerical ID variable that represents the number of spares added per emergency..}} | *EmergAddNumberVariableID (as ''integer'') {{APIComment|Gets the numerical ID variable that represents the number of spares added per emergency..}} |
Revision as of 21:40, 12 March 2014
Spare part pools are assigned to tasks. They are used to describe the conditions that determine whether a spare part will be available when needed and to specify the time and costs associated with obtaining the spare part.
Constructors
- cPool Creates a new pool resource.
Properties
Pool
- Name (as string) Gets or sets the name of the pool.
- ID (as integer) Gets the numerical ID of the pool.
- ProjectID (as integer) Gets the numerical ID of the project the pool belongs to.
Spares
- DirectCostModelID (as integer) Gets or sets the numerical ID of the model that represents the pool's direct cost per dispensed item.
- IndirectCostModelID (as integer) Gets the numerical ID of the model that represents the pool's logistic time for spare acquisition.
- SparesLimit (as integer) Gets the pool's initial stock level.
- SparesLimitVariableID (as integer) Gets the numerical ID of the pool's spares limit variable.
- DelayModelID (as integer) Gets the numerical ID of the pool's delay model.
- UseFixedProbability (as boolean) Gets or sets whether fixed probability should be used as a spare acquisition type.
- UseFixedProbabilityValue (as double) Gets a fixed probability value for the pool.
Pool Restock Properties
- RestockOn (as integer) Gets the pool's RestockOn number (0 = no restock, 1 = scheduled restock, 2 = restock as needed, 3 = both 1 and 2).
- RestockEvery (as double) Gets or sets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.
- RestockEveryUnit (as integer) Gets or sets the units of measurement for the RestockEvery property (1 = the first unit of measurement in the repository).
- RestockEveryVariableID (as integer) Gets the numerical ID of pool's "Restock every" variable.
- RestockAddNumber1 (as integer) Gets the number added per restock for scheduled restocking.
- RestockAddNumber1VariableID (as integer) Gets the numerical ID of the variable that represents the number added per restock for scheduled restocking.
- RestockWhen (as integer) Gets the pool's "Restock when stock drops to" value.
- RestockWhenVariableID (as integer) Gets the numerical ID of the variable that represents the pool's "Restock when stock drops to" value.
- RestockAddNumber2 (as integer) Gets the number added per restock for as-needed restocking.
- RestockAddNumber2VariableID (as integer) Gets the numerical ID of the variable that represents the number added per restock for as-needed restocking.
- RestockModelID (as integer) Gets the numerical ID of the pool's restock model.
- HasMaxCapacity (as boolean) Gets or sets whether the pool has a maximum capacity.
- MaxCapacity (as integer) Gets or sets the pool's maximum capacity.
- MaxCapacityVariableID (as integer) Gets the numerical ID of the variable that represents the pool's maximum capacity.
Emergency Spare Provisions
- CanObtainEmerg (as boolean) Gets or sets whether emergency spares can be obtained if needed.
- EmergAddNumber (as integer) Gets the number of spares added per emergency.
- EmergAddNumberVariableID (as integer) Gets the numerical ID variable that represents the number of spares added per emergency..
- EmergAddCostModelID (as integer) Gets the numerical ID of model that represents the additional costs for emergency spares.
- EmergModelID (as integer) Gets the numerical ID of the model that represents the required time for emergency spares.
- OffSitePoolRegularID (as integer) Gets the numerical ID of the model that represents the off-site spare part pool under the emergency spare provisions.
- OffSitePoolEmergencyID (as integer) Gets the numerical ID of the model that represents the logistic time for spare acquisition under the emergency spare provisions.