Model.hm_getusermark

Model.hm_getusermark(entity_type)

Returns the list entities that exist on the user mark. Only one user mark exists for each entity type.

The user mark is created either through panel input collectors via the “save” extended entity selection option or as an output in some function (see Model.equivalence()).

Parameters:

entity_type (EntityFullType) – Entity type saved in user mark.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • entityList (EntityList)

Example

Get the user mark of properties

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getusermark(entity_type = ent.Property)

print("Properties saved into the user mark are: ", [p.id for p in result.entityList])