Model.hm_gettypefromidpoolnumber#
- Model.hm_gettypefromidpoolnumber(solvercode, poolnumber)#
Returns the type for a specified pool ID in the current user profile.
- Parameters:
solvercode (int) – The ID of the solver template. Set to 0 to use current template.
poolnumber (int) – The ID of the solver pool to query.
- Returns:
hwReturnStatus- Status objectHmQueryResult- Result object containing the output values:poolType (str)
Example#
Get the type for ID pool 20 for current solver#import hm import hm.entities as ent model = hm.Model() _, result = model.hm_gettypefromidpoolnumber(solvercode=0,poolnumber=20) print("poolType:", result.poolType)
Note
The solvercode can be retrieved using
Model.hm_getsolver()and if set to 0, it uses the current solver/template.