Model.CE_DetailSetDoubleByMark

Model.CE_DetailSetDoubleByMark(collection, detail_name, double_value, reserved, force_storage)

Sets a double 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 double detail, or user-defined double detail to update. See Model.CE_DetailSetDouble() for valid details.

• double_value (double) – The double 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 tolerance to 10.0 for connectors with IDs 1, 2 and 3

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetDoubleByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3]),
    detail_name="ce_tolerance",
    float_value=10.0,
    reserved=0,
    force_storage=0,
)

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

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetDoubleByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3]),
    detail_name="test",
    float_value=5.0,
    reserved=0,
    force_storage=1,
)