Model.hm_entitymaxsolverid#
- Model.hm_entitymaxsolverid(entity_type, id_pool_name='')#
Returns the maximum solver ID in use for an entity type.
- Parameters:
entity_type (EntityFullType) – The type of entity to query.
id_pool_name (hwString) – An optional argument, indicating whether the maximum internal ID should be considered over all ID pools or a specific ID pool only.
- Returns:
hwReturnStatus- Status objectHmQueryResult- Result object containing the output values:maxSolverID (int)
Examples#
Get the maximum internal ID for properties#import hm import hm.entities as ent model = hm.Model() _, result = model.hm_entitymaxsolverid(entity_type=ent.Property) print("maxSolverID", result.maxSolverID)
Get the maximum solver ID for properties in the two_idpool property ID pool#import hm import hm.entities as ent model = hm.Model() _, result = model.hm_entitymaxsolverid(entity_type=ent.Property, id_pool_name="two_idpool") print("maxSolverID", result.maxSolverID)