Model.CE_DetailSetUintByMark

Model.CE_DetailSetUintByMark(collection, detailName, uint_val, unknownFlag, force_storage_flag)

Sets an unsigned integer as connector detail for a collection of connectors.

Parameters:

• collection (Collection) – The collection containing the connector entities to attach details to.

• detailName (hwString) – Name for a user-defined unsigned integer detail.

• uint_val (unsigned int) – The unsigned integer value for the detail.

• unknownFlag (unsigned int) – Reserved for future development. Must be set to 0.

• force_storage_flag (unsigned int) –

  The flag indicating whether or not to store a user-defined detail.

  0 - No

  1 - Yes

Example

Set a user-defined unsigned integer detail “test = 2.0” for connectors with IDs 1, 2, 3, and 4

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetUintByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3, 4]),
    detailName="test",
    uint_val=2.0,
    unknownFlag=0,
    force_storage_flag=1,
)