Model.CE_DetailSetIntByMark

Model.CE_DetailSetIntByMark(collection, detail_name, integer_value, reserved, force_storage)

Sets an integer connector detail for a collection of connectors.

Parameters:

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

• detail_name (hwString) – The name of the standard integer detail, or user-defined integer detail, to update. See Model.CE_DetailSetInt() for valid details.

• integer_value (int) – The integer 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.

Examples

Set the thickness (number of layers) to 3 for connectors with IDs 1, 2 and 3

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetIntByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3]),
    detail_name="ce_layers",
    integer_value=3,
    reserved=0,
    force_storage=0,
)

Set a user-defined integer detail “test” to a value of 5 for connectors with IDs 2 and 3

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetIntByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3]),
    detail_name="test",
    integer_value=5,
    reserved=0,
    force_storage=1,
)