Model.renamecollector#

Model.renamecollector(entity_type, collector_name, new_name)#

Renames a collector.

Parameters:

  • entity_type (EntityFullType) – The type of collector being renamed.

  • collector_name (hwString) – The name of the collector to be renamed.

  • new_name (hwString) – The new name which should be assigned to the collector. For entity types enabled for the name pool, this is the solver name, otherwise the internal name.

Example#

Rename component “oldname” to “newname”#
import hm
import hm.entities as ent

model = hm.Model()

model.renamecollector(
    entity_type=ent.Component, collector_name="oldname", new_name="newname"
)