Model.moveincludecontents

Model.moveincludecontents(source_id, source_shortname, dest_shortname, delete_flag)

Moves the contents of one include to another, with an option to delete the source include.

Parameters:

• source_id (unsigned int) – The ID of the source include file. If this is not available, use 0 and specify source_shortname.

• source_shortname (hwString) – The shortname of the source include file. This is only used if source_id=0 or cannot be found. If this is not required, specify double quotes “”.

• dest_shortname (hwString) – The shortname of the destination include file.

• delete_flag (int) –

  Flag to indicate if the source include should be deleted. Valid values are:

  0 - Do not delete

  1 - Delete

Example

Move the contents of include with shortname “ front_door “ to include with shortname “ front_door_new “ , delete the source include

import hm
import hm.entities as ent

model = hm.Model()

model.moveincludecontents(
    source_id=0,
    source_shortname="front_door",
    dest_shortname="front_door_new",
    delete_flag=1,
)