CPool Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:


=== Properties  ===
=== Properties  ===
*'''[[Name - cPool|Name]]''' {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
*'''[[cPool.Name|Name]]''' {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
*'''[[ID - cPool|ID]]''' {{APIComment|Returns the ID of the resource (the one used in the repository).}}
*'''[[cPool.ID|ID]]''' {{APIComment|Returns the ID of the resource (the one used in the repository).}}
*'''[[ProjectID - cPool|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}}
*'''[[cPool.ProjectID|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.}}
*'''[[cPool.DirectCostModelID|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.}}
*'''[[cPool.IndirectCostModelID|IndirectCostModelID]]''' {{APIComment|Returns the indirect cost model ID the resource belongs to.}}
*'''[[SparesLimit]]''' {{APIComment|Returns the spares limit ID the resource belongs to.}}
*'''[[cPool.SparesLimit|SparesLimit]]''' {{APIComment|Returns the spares limit ID the resource belongs to.}}
*'''[[SparesLimitVariableID]]''' {{APIComment|Returns the ID of the spares limit variable the resource belongs to.}}
*'''[[cPool.SparesLimitVariableID|SparesLimitVariableID]]''' {{APIComment|Returns the ID of the spares limit variable the resource belongs to.}}
*'''[[DelayModelID - cPool|DelayModelID]]''' {{APIComment|Returns the ID of the delay model the resource belongs to.}}
*'''[[cPool.DelayModelID|DelayModelID]]''' {{APIComment|Returns the ID of the delay model the resource belongs to.}}
*'''[[UseFixedProbability]]''' {{APIComment|Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.}}
*'''[[cPool.UseFixedProbability|UseFixedProbability]]''' {{APIComment|Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.}}
*'''[[UseFixedProbabilityValue]]''' {{APIComment|Returns a fixed probability value for the resource.}}
*'''[[cPool.UseFixedProbabilityValue|UseFixedProbabilityValue]]''' {{APIComment|Returns a fixed probability value for the resource.}}
*'''[[RestockOn]]''' {{APIComment|Returns the Restock number the resource belongs to.}}
*'''[[cPool.RestockOn|RestockOn]]''' {{APIComment|Returns the Restock number the resource belongs to.}}
*'''[[RestockEvery]]''' {{APIComment|Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}}
*'''[[cPool.RestockEvery|RestockEvery]]''' {{APIComment|Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.}}
*'''[[RestockEveryUnit]]''' {{APIComment|Sets or returns temporal units for RestockEvery Property for the resource belonged to.}}
*'''[[cPool.RestockEveryUnit|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.}}
*'''[[cPool.RestockEveryVariableID|RestockEveryVariableID]]''' {{APIComment|Returns the ID of RestockEveryVariable the resource belongs to.}}
*'''[[RestockAddNumber1]]''' {{APIComment|Returns a restock value of 1 for the resource.}}
*'''[[cPool.RestockAddNumber1|RestockAddNumber1]]''' {{APIComment|Returns a restock value of 1 for the resource.}}
*'''[[RestockAddNumber1VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber1 the resource belongs to.}}
*'''[[cPool.RestockAddNumber1VariableID|RestockAddNumber1VariableID]]''' {{APIComment|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.}}
*'''[[cPool.RestockWhen|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 Restock when set variable ID the resource belongs to.}}
*'''[[cPool.RestockWhenVariableID|RestockWhenVariableID]]''' {{APIComment|Returns the ID of the Restock when set variable ID the resource belongs to.}}
*'''[[RestockAddNumber2]]''' {{APIComment|Returns the RestockAddNumber2 the resource belongs to.}}
*'''[[cPool.RestockAddNumber2|RestockAddNumber2]]''' {{APIComment|Returns the RestockAddNumber2 the resource belongs to.}}
*'''[[RestockAddNumber2VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber2 Variable the resource belongs to.}}
*'''[[cPool.RestockAddNumber2VariableID|RestockAddNumber2VariableID]]''' {{APIComment|Returns the ID of RestockAddNumber2 Variable the resource belongs to.}}
*'''[[RestockModelID]]''' {{APIComment|Returns the ID of the restock model the resource belongs to.}}
*'''[[cPool.RestockModelID|RestockModelID]]''' {{APIComment|Returns the ID of the restock model the resource belongs to.}}
*'''[[HasMaxCapacity]]''' {{APIComment|Sets or returns whether a pool has maximum capacity for the resource belonged to.}}
*'''[[cPool.HasMaxCapacity|HasMaxCapacity]]''' {{APIComment|Sets or returns whether a pool has maximum capacity for the resource belonged to.}}
*'''[[MaxCapacity]]''' {{APIComment|Sets or returns the maximum capacity the resource belongs to.}}
*'''[[cPool.MaxCapacity|MaxCapacity]]''' {{APIComment|Sets or returns the maximum capacity the resource belongs to.}}
*'''[[MaxCapacityVariableID]]''' {{APIComment|Returns the ID of the maximum capacity variable the resource belongs to.}}
*'''[[cPool.MaxCapacityVariableID|MaxCapacityVariableID]]''' {{APIComment|Returns the ID of the maximum capacity variable the resource belongs to.}}
*'''[[CanObtainEmerg]]''' {{APIComment|Sets or returns whether emergency spares can be obtained for the resource belonged to.}}
*'''[[cPool.CanObtainEmerg|CanObtainEmerg]]''' {{APIComment|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.}}
*'''[[cPool.EmergAddNumber|EmergAddNumber]]''' {{APIComment|Returns the number of spares added per emergency the resource belongs to.}}
*'''[[EmergAddNumberVariableID ]]''' {{APIComment|Returns the ID of the EmergAddNumber variable for which the resource belongs to.}}
*'''[[cPool.EmergAddNumberVariableID|EmergAddNumberVariableID ]]''' {{APIComment|Returns the ID of the EmergAddNumber variable for which the resource belongs to.}}
*'''[[EmergAddCostModelID ]]''' {{APIComment|Returns the ID of EmergAddCostModel for which the resource belongs to.}}
*'''[[cPool.EmergAddCostModelID|EmergAddCostModelID ]]''' {{APIComment|Returns the ID of EmergAddCostModel for which the resource belongs to.}}
*'''[[EmergModelID ]]''' {{APIComment|Returns the ID of EmergModel for which the resource belongs to.}}
*'''[[cPool.EmergModelID|EmergModelID ]]''' {{APIComment|Returns the ID of EmergModel for which the resource belongs to.}}
*'''[[OffSitePoolRegularID ]]''' {{APIComment|Returns the ID of OffSitePoolRegular for which the resource belongs to.}}
*'''[[cPool.OffSitePoolRegularID|OffSitePoolRegularID]]''' {{APIComment|Returns the ID of OffSitePoolRegular for which the resource belongs to.}}
*'''[[OffSitePoolEmergencyID ]]''' {{APIComment|Returns the ID of OffSitePoolEmergency for which the resource belongs to.}}
*'''[[cPool.OffSitePoolEmergencyID|OffSitePoolEmergencyID ]]''' {{APIComment|Returns the ID of OffSitePoolEmergency for which the resource belongs to.}}

Revision as of 21:52, 18 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.
  • RestockAddNumber1 Returns a restock value of 1 for the resource.
  • RestockAddNumber1VariableID Returns the ID of RestockAddNumber1 the resource belongs to.
  • RestockWhen 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 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 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 Returns the ID of EmergModel for which the resource belongs to.
  • OffSitePoolRegularID Returns the ID of OffSitePoolRegular for which the resource belongs to.
  • OffSitePoolEmergencyID Returns the ID of OffSitePoolEmergency for which the resource belongs to.