Model.markmovetoincludewithcontents

Model.markmovetoincludewithcontents(collection, include_id, child_entity_types)

Organizes entities into an include file, optionally also moving child entities.

Parameters:

• collection (Collection) – The collection containing the entities to organize.

• include_id (unsigned int) – The ID of the include file to organize the entities into.

• child_entity_types (hwString) – The type/types of the child entities to organize. Multiple types can be specified at a time.

Example

Move system collector “ systcol1 “ along with all of its systems into include file number 2

import hm
import hm.entities as ent

model = hm.Model()

systcols = hm.Collection(model,ent.Systcol,"name=systcol1")
model.markmovetoincludewithcontents(collection=systcols, include_id=2,child_entity_types="systems")

Move component “ comp1 “ along with all of its nodes and elements into include file number 2

import hm
import hm.entities as ent

model = hm.Model()

comps = hm.Collection(model,ent.Component,"name=comp1")
model.markmovetoincludewithcontents(collection=comps, include_id=2,child_entity_types="nodes elements")