CPool Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) |
Chris Kahn (talk | contribs) |
||
| Line 8: | Line 8: | ||
== Properties == | == Properties == | ||
*Name (as ''string'') {{APIComment|Sets or gets the name of the pool.}} | *Name (as ''string'') {{APIComment|Sets or gets the name of the pool.}} | ||
*ID (as ''integer'') {{APIComment|Gets the 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.}} | ||
*DirectCostModelID (as ''integer'') {{APIComment|Sets or gets the numerical ID of the model that represents the pool's direct cost per dispensed item.}} | *DirectCostModelID (as ''integer'') {{APIComment|Sets or gets the numerical ID of the model that represents the pool's direct cost per dispensed item.}} | ||
| Line 15: | Line 15: | ||
*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|Sets or gets whether fixed probability should be used as a spare acquisition type | *UseFixedProbability (as ''boolean'') {{APIComment|Sets or gets 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.}} | ||
*RestockOn (as ''integer'') {{APIComment|Gets the pool's | *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|Sets or gets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}} | *RestockEvery (as ''double'') {{APIComment|Sets or gets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}} | ||
*RestockEveryUnit (as ''integer'') {{APIComment|Sets or gets the units of measurement.}} | *RestockEveryUnit (as ''integer'') {{APIComment|Sets or gets the units of measurement.}} | ||
Revision as of 23:29, 11 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
- Name (as string) Sets or gets 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.
- DirectCostModelID (as integer) Sets or gets 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) Sets or gets whether fixed probability should be used as a spare acquisition type.
- UseFixedProbabilityValue (as double) Gets a fixed probability value for the pool.
- RestockOn (as integer) {{{1}}}
- RestockEvery (as double) Sets or gets the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.
- RestockEveryUnit (as integer) Sets or gets the units of measurement.
- RestockEveryVariableID (as integer) Gets the numerical ID of RestockEveryVariable the resource belongs to.
- RestockAddNumber1 (as integer) Gets a restock value of 1 for the resource.
- RestockAddNumber1VariableID (as integer) Gets the numerical ID of RestockAddNumber1 the resource belongs to.
- RestockWhen (as integer) Gets the value that restock is needed at when stock drops to that value within the resource belonged to.
- RestockWhenVariableID (as integer) Gets the numerical ID of the Restock when set variable ID the resource belongs to.
- RestockAddNumber2 (as integer) Gets the pool's RestockAddNumber2.
- RestockAddNumber2VariableID (as integer) Gets the numerical ID of the pool's RestockAddNumber2 Variable.
- RestockModelID (as integer) Gets the numerical ID of the pool's restock model.
- HasMaxCapacity (as boolean) Sets or gets whether a pool has a maximum capacity.
- MaxCapacity (as integer) Sets or gets the pool's maximum capacity.
- MaxCapacityVariableID (as integer) Gets the numerical ID of the variable that represents the pool's maximum capacity.
- CanObtainEmerg (as boolean) Sets or gets whether emergency spares can be obtained for the pool.
- EmergAddNumber (as integer) Gets the number of spares added per emergency.
- EmergAddNumberVariableID (as integer) Gets the numerical ID of the pool's EmergAddNumber variable.
- EmergAddCostModelID (as integer) Gets the numerical ID of the pool's EmergAddCostModel.
- EmergModelID (as integer) Gets the numerical ID of pool's EmergModel.
- OffSitePoolRegularID (as integer) Gets the numerical ID of the pool's OffSitePoolRegular.
- OffSitePoolEmergencyID (as integer) Gets the numerical ID of the pool's OffSitePoolEmergency.