Model.hm_ce_generatenamefrominclude

Model.hm_ce_generatenamefrominclude(connector_entity, base_name)

Returns a name using a base name and connector include ID.

This returns a string like <base_name>_inc<ID> where ID is the include ID of the connector.

Parameters:

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

• base_name (hwString) – The base name to append.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • generatedName (str)

Examples

Generate a name for connector with ID 2 and the base “ hexa_comp “

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_ce_generatenamefrominclude(
  connector=ent.Connector(model, 2),
  base_name="hexa_comp"
)

print("Generated Name: ", result.generatedName)