Model.includesuppressactive#

Model.includesuppressactive(include_id, include_shortname, state)#

Sets the active/inactive 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. Double quotes “” must be used for an argument that is not specified.

Include files do not have an active/inactive state, only the entities contained within them.

Parameters:

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

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

  • state (int) –

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

    0 - Indicates to set the entities to active and turn on their display.

    1 - Indicates to set the entities to inactive and remove them from the display.

    2 - Indicates to set the entities to active but not to re-display them.

Examples#

Set all supported entities contained within include file ID 5 to active and re - display#
import hm
import hm.entities as ent

model = hm.Model()

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

model = hm.Model()

model.includesuppressactive(include_id=None, include_shortname="include.txt", state=1)
Set all supported entities contained within include file ID 5 to active and not re - display#
import hm
import hm.entities as ent

model = hm.Model()

model.includesuppressactive(include_id=5, include_shortname="", state=2)