Model.includesuppressoutput#

Model.includesuppressoutput(include_id, include_shortname, state)#

Sets the export/do not export state of all supported entities contained within the include file (but not the include file itself) with include_id and include_shortname. Only one of these two options need to be specified, however include_id will take precedence if specified.

The state argument indicates the export/do not export status for the supported entities contained in the include. If state=0 indicates to set the entities to “export”. If state=1 indicates to set the entities to “do not export”.

Include files do not have an export/do not export state that is controlled by this function. Instead use the function Model.updateincludedata2().

Parameters:

  • include_id (unsigned int) – The ID of the include file.

  • include_shortname (hwString) – The name of the include file.

  • state (int) –

    The state argument indicates the active/inactive status for the supported entities contained in the include.

    0 - Indicates to set the entities to “export”.

    1 - Indicates to set the entities to “do not export”.

Examples#

Set all supported entities contained within include file ID 5 to “ export “#
import hm
import hm.entities as ent

model = hm.Model()

model.includesuppressoutput(include_id=5, include_shortname="", state=0)
Set all supported entities contained within include file shortname “ include.txt “ to “ do not export “#
import hm
import hm.entities as ent

model = hm.Model()

model.includesuppressoutput(include_id=None, include_shortname="include.txt", state=1)