Model.hm_modent_getcontentsbymark#

Model.hm_modent_getcontentsbymark(entity, output_collection)#

Returns a collection of entities which are contents of a subsystem entity.

Parameters:

  • entity (Entity) – The object describing the entity. Currently supported for subsystemconfigurations, subsystems and subsystemsets.

  • output_collection (Collection) – The collection containing the entities to return the content entities.

Returns:

Example#

Get the components for subsystem with ID 2 on output collection#
import hm
import hm.entities as ent

model = hm.Model()

output_col = hm.Collection(model, ent.Subsystem, populate=False)

model.hm_modent_getcontentsbymark(
    entity=ent.Subsystem(model, 2), subsystems_collection=output_col
)