Model.hm_getincludesentities_bynames

Model.hm_getincludesentities_bynames(include_names, collection_set)

Selects entities and returns the entity types contained in specified include files. The return value is the list of entity types found in the specified includes. The actual entities are populated on the specified collection.

Parameters:

• include_names (hwStringList) – The names of the includes to query.

• collection_set (CollectionSet) – The set of collections containing possibly multiple type of found entities.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • entity_types (numpy.ndarray)

Example

Find all of the entities in include names inc1 , inc2 , inc3 , inc4

import hm
import hm.entities as ent

model = hm.Model()

output = hm.CollectionSet(model)

_, result = model.hm_getincludesentities_bynames(include_names=["inc1", "inc2", "inc3", "inc4"], collection_set=output)

print("entity_types", result.entity_types)