Model.hm_isentitydatanameparameterized_byentity

Model.hm_isentitydatanameparameterized_byentity(entity, attribute_id, row=-1, column=-1)

Returns parameter ID if the specified data name or attribute is parameterized, otherwise returns value of 0.

Parameters:

• entity (Entity) – The object describing the entity to query.

• attribute_id (int) – The template attribute ID to query.

• row (int) – Row index for a 1D or 2D array. For a 1D array, it checks the parameterization at the specified row index. For a 2D array, it will check for the entire row. This should be blank for non-array data names/attributes.

• column (int) – Column index for a 2D array. Used together with row_index, it checks the parameterization at the specified row_index and column_index. This should be blank for non-array data names/attributes.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • parameterID (int)

Example

Check the parameterization of attribute with ID 1 for set entity with ID 5

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_isentitydatanameparameterized_byentity(
    entity=ent.Set(model, 5),
    attribute_id=1
)

print("parameterID", result.parameterID)