Model.correctalloverflowsubmodelentityids#

Model.correctalloverflowsubmodelentityids(submodel_type, id, entity_type, renum_option, poolid)#

Corrects an entity ID range overflow for a submodel.

Parameters:
  • submodel_type (hwString) – Submodel type to correct the ID range overflow for a submodel. Valid values are “includes” and “includefiles”.

  • id (hwString) – The ID of the submodel.

  • entity_type (hwStringList) – The type of entity to correct the overflow for. If set to 0, all entity types in the submodel are considered.

  • renum_option (hwUIntList) –

    1 - Compact and fit (default)

    2 - Move after max

    3 - Move before min

    4 - Insert in gaps

    5 - Offset and fit (not yet supported)

  • poolid (unsigned int) – Reserved for future development

Example#

Correct all overflows in include file 1 with “both” overflow option and using “move after max” renumber option#
import hm
import hm.entities as ent

model = hm.Model()

model.correctalloverflowsubmodelentityids(
    submodel_type="includes", id=1, entity_type="2", renum_option=2, poolid=0
)