CPool Class: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) (Created page with '{{Template:APIClass|CPool Class|CPool}} Spare part pools are assigned to tasks. They are used to describe the conditions that determine whether a spare part will be available w…') |
John Leavitt (talk | contribs) No edit summary |
||
| Line 12: | Line 12: | ||
*'''[[ProjectID - cPool|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}} | *'''[[ProjectID - cPool|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}} | ||
*'''[[DirectCostModelID]]''' {{APIComment|Sets or returns the direct cost model ID the resource belongs to.}} | *'''[[DirectCostModelID]]''' {{APIComment|Sets or returns the direct cost model ID the resource belongs to.}} | ||
*'''[[ | *'''[[IndirectCostModelID]]''' {{APIComment|Returns the indirect cost model ID the resource belongs to.}} | ||
*'''[[SparesLimit]]''' {{APIComment| | *'''[[SparesLimit]]''' {{APIComment|Returns the spares limit ID the resource belongs to.}} | ||
*'''[[SparesLimitVariableID]]''' {{APIComment| | *'''[[SparesLimitVariableID]]''' {{APIComment|Returns the ID of the spares limit variable the resource belongs to.}} | ||
*'''[[DelayModelID - cPool|DelayModelID]]''' {{APIComment| | *'''[[DelayModelID - cPool|DelayModelID]]''' {{APIComment|Returns the ID of the delay model the resource belongs to.}} | ||
*'''[[UseFixedProbability]]''' {{APIComment|Sets or returns whether | *'''[[UseFixedProbability]]''' {{APIComment|Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.}} | ||
*'''[[RestockOn]]''' {{APIComment| | *'''[[UseFixedProbabilityValue]]''' {{APIComment|Returns a fixed probability value for the resource.}} | ||
*'''[[RestockEvery]]''' {{APIComment|Sets or returns the | *'''[[RestockOn]]''' {{APIComment|Returns the Restock number the resource belongs to.}} | ||
*'''[[RestockEveryUnit]]''' {{APIComment| | *'''[[RestockEvery]]''' {{APIComment|Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}} | ||
*'''[[RestockEveryVariableID]]''' {{APIComment|Returns the ID of | *'''[[RestockEveryUnit]]''' {{APIComment|Sets or returns temporal units for RestockEvery Property for the resource belonged to.}} | ||
*'''[[RestockEveryVariableID]]''' {{APIComment|Returns the ID of RestockEveryVariable the resource belongs to.}} | |||
*'''[[DirectCostModelID]]''' {{APIComment|Sets or returns the direct cost model ID the resource belongs to.}} | *'''[[DirectCostModelID]]''' {{APIComment|Sets or returns the direct cost model ID the resource belongs to.}} | ||
*'''[[ | *'''[[IndirectCostModelID]]''' {{APIComment|Sets or returns the cost per incident ID the resource belongs to.}} | ||
*'''[[SparesLimit]]''' {{APIComment|Sets or returns if there is a limit to the number of tasks a crew can perform.}} | *'''[[SparesLimit]]''' {{APIComment|Sets or returns if there is a limit to the number of tasks a crew can perform.}} | ||
*'''[[SparesLimitVariableID]]''' {{APIComment|Sets or returns the task limit ID the resource belongs to.}} | *'''[[SparesLimitVariableID]]''' {{APIComment|Sets or returns the task limit ID the resource belongs to.}} | ||
*'''[[RestockAddNumber1]]''' {{APIComment| | *'''[[RestockAddNumber1]]''' {{APIComment|Returns a restock value of 1 for the resource.}} | ||
*'''[[RestockAddNumber1VariableID]]''' {{APIComment| | *'''[[RestockAddNumber1VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber1 the resource belongs to.}} | ||
*'''[[RestockWhen]]''' {{APIComment| | *'''[[RestockWhen]]''' {{APIComment|Returns the value that restock is needed at when stock drops to that value within the resource belonged to.} | ||
*'''[[RestockWhenVariableID]]''' {{APIComment|Returns the ID of the resource | *'''[[RestockWhenVariableID]]''' {{APIComment|Returns the ID of the Restock when set variable ID the resource belongs to.}} | ||
*'''[[RestockAddNumber2]]''' {{APIComment|Returns the | *'''[[RestockAddNumber2]]''' {{APIComment|Returns the RestockAddNumber2 the resource belongs to.}} | ||
*'''[[RestockAddNumber2VariableID]]''' {{ | *'''[[RestockAddNumber2VariableID]]''' {{Returns the ID of RestockAddNumber2 Variable the resource belongs to.}} | ||
*'''[[RestockModelID]]''' {{APIComment| | *'''[[RestockModelID]]''' {{APIComment|Returns the ID of the restock model the resource belongs to.}} | ||
*'''[[HasMaxCapacity]]''' {{APIComment|Sets or returns | *'''[[HasMaxCapacity]]''' {{APIComment|Sets or returns whether a pool has maximum capacity for the resource belonged to.}} | ||
*'''[[MaxCapacity]]''' {{APIComment|Sets or returns the | *'''[[MaxCapacity]]''' {{APIComment|Sets or returns the maximum capacity the resource belongs to.}} | ||
*'''[[MaxCapacityVariableID]]''' {{APIComment| | *'''[[MaxCapacityVariableID]]''' {{APIComment|Returns the ID of the maximum capacity variable the resource belongs to.}} | ||
*'''[[CanObtainEmerg]]''' {{APIComment|Sets or returns whether | *'''[[CanObtainEmerg]]''' {{APIComment|Sets or returns whether emergency spares can be obtained for the resource belonged to.}} | ||
*'''[[EmergAddNumber]]''' {{APIComment| | *'''[[EmergAddNumber]]''' {{APIComment|Returns the number of spares added per emergency the resource belongs to.} | ||
*'''[[EmergAddNumberVariableID ]]''' {{APIComment| | *'''[[EmergAddNumberVariableID ]]''' {{APIComment|Returns the ID of the EmergAddNumber variable for which the resource belongs to.}} | ||
*'''[[EmergAddCostModelID ]]''' {{APIComment| | *'''[[EmergAddCostModelID ]]''' {{APIComment|Returns the ID of EmergAddCostModel for which the resource belongs to.}} | ||
*'''[[EmergModelID ]]''' {{APIComment| | *'''[[EmergModelID ]]''' {{APIComment|Returns the ID of EmergModel for which the resource belongs to.} | ||
*'''[[OffSitePoolRegularID ]]''' {{APIComment| | *'''[[OffSitePoolRegularID ]]''' {{APIComment|Returns the ID of OffSitePoolRegular for which the resource belongs to.}} | ||
*'''[[OffSitePoolEmergencyID ]]''' {{APIComment| | *'''[[OffSitePoolEmergencyID ]]''' {{APIComment|Returns the ID of OffSitePoolEmergency for which the resource belongs to.} | ||
Revision as of 21:43, 5 September 2013
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
- Sub New Creates a new instance of the resource.
Properties
- Name Sets or returns the name of the model (the one used in the repository)
- ID Returns the ID of the resource (the one used in the repository).
- ProjectID Returns the ID of the project the resource belongs to.
- DirectCostModelID Sets or returns the direct cost model ID the resource belongs to.
- IndirectCostModelID Returns the indirect cost model ID the resource belongs to.
- SparesLimit Returns the spares limit ID the resource belongs to.
- SparesLimitVariableID Returns the ID of the spares limit variable the resource belongs to.
- DelayModelID Returns the ID of the delay model the resource belongs to.
- UseFixedProbability Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.
- UseFixedProbabilityValue Returns a fixed probability value for the resource.
- RestockOn Returns the Restock number the resource belongs to.
- RestockEvery Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.
- RestockEveryUnit Sets or returns temporal units for RestockEvery Property for the resource belonged to.
- RestockEveryVariableID Returns the ID of RestockEveryVariable the resource belongs to.
- DirectCostModelID Sets or returns the direct cost model ID the resource belongs to.
- IndirectCostModelID Sets or returns the cost per incident ID the resource belongs to.
- SparesLimit Sets or returns if there is a limit to the number of tasks a crew can perform.
- SparesLimitVariableID Sets or returns the task limit ID the resource belongs to.
- RestockAddNumber1 Returns a restock value of 1 for the resource.
- RestockAddNumber1VariableID Returns the ID of RestockAddNumber1 the resource belongs to.
- RestockWhen {{APIComment|Returns the value that restock is needed at when stock drops to that value within the resource belonged to.}
- RestockWhenVariableID Returns the ID of the Restock when set variable ID the resource belongs to.
- RestockAddNumber2 Returns the RestockAddNumber2 the resource belongs to.
- RestockAddNumber2VariableID Template:Returns the ID of RestockAddNumber2 Variable the resource belongs to.
- RestockModelID Returns the ID of the restock model the resource belongs to.
- HasMaxCapacity Sets or returns whether a pool has maximum capacity for the resource belonged to.
- MaxCapacity Sets or returns the maximum capacity the resource belongs to.
- MaxCapacityVariableID Returns the ID of the maximum capacity variable the resource belongs to.
- CanObtainEmerg Sets or returns whether emergency spares can be obtained for the resource belonged to.
- EmergAddNumber {{APIComment|Returns the number of spares added per emergency the resource belongs to.}
- EmergAddNumberVariableID Returns the ID of the EmergAddNumber variable for which the resource belongs to.
- EmergAddCostModelID Returns the ID of EmergAddCostModel for which the resource belongs to.
- EmergModelID {{APIComment|Returns the ID of EmergModel for which the resource belongs to.}
- OffSitePoolRegularID Returns the ID of OffSitePoolRegular for which the resource belongs to.
- OffSitePoolEmergencyID {{APIComment|Returns the ID of OffSitePoolEmergency for which the resource belongs to.}