Model.hm_getentitycardimagedictionary

Model.hm_getentitycardimagedictionary(entity_type, type='')

Certain entity card images have organizational types defined in the templates which are used by the panels and the browsers to filter and organize the available entity card images (dictionaries). This function returns a list of card images defined in the current template that are of the specified type for the specified entity_type.

Parameters:

• entity_type (EntityFullType) – Currently supported for controlvolumes, materials, properties, sensors, sets and tables.

• type (hwString) – The organizational type of the entity to return the card image list for. Also valid for ALL and NOTYPE.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • cardImagesList (list of strings)

Example

Return the list of card images for properties of type 1D defined for the OptiStruct solver profile

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitycardimagedictionary(entity_type=ent.Property, type="1D")

print("CardImage List:", result.cardImagesList)