CPool Class: Difference between revisions

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


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

Revision as of 17:21, 10 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 returns the name of the model (the one used in the repository)
  • ID (as integer) Returns the ID of the resource (the one used in the repository).
  • ProjectID (as integer) Returns the ID of the project the resource belongs to.
  • DirectCostModelID (as integer) Sets or returns the direct cost model ID the resource belongs to.
  • IndirectCostModelID (as integer) Returns the indirect cost model ID the resource belongs to.
  • SparesLimit (as integer) Returns the spares limit ID the resource belongs to.
  • SparesLimitVariableID (as integer) Returns the ID of the spares limit variable the resource belongs to.
  • DelayModelID (as integer) Returns the ID of the delay model the resource belongs to.
  • UseFixedProbability (as boolean) Sets or returns whether fixed probability should be used as a spare acquisition type for the resource.
  • UseFixedProbabilityValue (as double) Returns a fixed probability value for the resource.
  • RestockOn (as integer) Returns the Restock number the resource belongs to.
  • RestockEvery (as double) Sets or returns the value for how often a pool should be restocked for the resource given RestockEveryUnit Property.
  • RestockEveryUnit (as integer) Sets or returns temporal units for RestockEvery Property for the resource belonged to.
  • RestockEveryVariableID (as integer) Returns the ID of RestockEveryVariable the resource belongs to.
  • RestockAddNumber1 (as integer) Returns a restock value of 1 for the resource.
  • RestockAddNumber1VariableID (as integer) Returns the ID of RestockAddNumber1 the resource belongs to.
  • RestockWhen (as integer) Returns the value that restock is needed at when stock drops to that value within the resource belonged to.
  • RestockWhenVariableID (as integer) Returns the ID of the Restock when set variable ID the resource belongs to.
  • RestockAddNumber2 (as integer) Returns the RestockAddNumber2 the resource belongs to.
  • RestockAddNumber2VariableID (as integer) Returns the ID of RestockAddNumber2 Variable the resource belongs to.
  • RestockModelID (as integer) Returns the ID of the restock model the resource belongs to.
  • HasMaxCapacity (as boolean) Sets or returns whether a pool has maximum capacity for the resource belonged to.
  • MaxCapacity (as integer) Sets or returns the maximum capacity the resource belongs to.
  • MaxCapacityVariableID (as integer) Returns the ID of the maximum capacity variable the resource belongs to.
  • CanObtainEmerg (as boolean) Sets or returns whether emergency spares can be obtained for the resource belonged to.
  • EmergAddNumber (as integer) Returns the number of spares added per emergency the resource belongs to.
  • EmergAddNumberVariableID (as integer) Returns the ID of the EmergAddNumber variable for which the resource belongs to.
  • EmergAddCostModelID (as integer) Returns the ID of EmergAddCostModel for which the resource belongs to.
  • EmergModelID (as integer) Returns the ID of EmergModel for which the resource belongs to.
  • OffSitePoolRegularID (as integer) Returns the ID of OffSitePoolRegular for which the resource belongs to.
  • OffSitePoolEmergencyID (as integer) Returns the ID of OffSitePoolEmergency for which the resource belongs to.