Model.CE_DetailSetString#

Model.CE_DetailSetString(connector_id, detail_name, string_value, reserved, force_storage)#

Sets a string connector detail for a single connector.

Parameters:

connector_id (unsigned int) – The ID of connector to update.
detail_name (hwString) –
The name of the standard string detail, or user-defined string detail, to update. Standard string details include:
- ce_collectorname
The component name of the connector entity.
- ce_configname
The FE config name of the realized connector.
- ce_connectivity
The connector FE connectivity.

independent

FE connectivity

dependent

use_shell_node, etc…
- ce_fesolver
The FE solver name.
- ce_fetypename
The realized FE type name defined in the feconfig.cfg file.
- ce_fe_fileattribute_entids
The entity IDs related to the file attribute option.

entity_type ID_1 ID_2 … (example: “materials 3 6 7”)
- ce_fe_folderattribute_entids
The entity IDs related to the folder attribute option.

entity_type ID_1 ID_2 … (example: “materials 3 6 7”)
- ce_positionstring
A list containing the entity type, followed by the entity IDs selected to create the connector.
- ce_propertyscript
The user property script used for realization.

Full absolute path and file name.
- ce_state
The connector entity state.

failed

realized

unrealized
- ce_style
The connector style.

app_mass

area

bolt

seam

spot
- ce_type
The connector entity type based on its creation.

area

line

node/point

seam
string_value (hwString) – The string value to update for the detail.
reserved (unsigned int) – Reserved for future development. Must be set to 0.
force_storage (unsigned int) –
0 - Do not store user-defined detail.

1 - Store user-defined detail.

Example#

Set the user property script for connector with ID 1#

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetString(
    connector_id=1,
    detail_name="ce_propertyscript",
    string_value="C:/temp/scripts/connectors/test.tcl",
    reserved=0,
    force_storage=0,
)