Model.CE_DetailDeleteByMark

Model.CE_DetailDeleteByMark(collection, detailType, detailName, unknownFlag)

Deletes connector details (stored in connector metadata) from connectors specified by collection.

Parameters:

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

• detailType (hwString) – Detail type to delete. Valid values are “int”, “uint”, “double”, “string” and “triple”.

• detailName (hwString) – The name of the detail to delete.

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

Example

Delete user defined integer detail named “test” for connectors with IDs 1 and 2

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailDeleteByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2]),
    detailType="int",
    detailName="test",
    unknownFlag=0,
)

Note

The following functions can be used to set user-defined details: CE_DetailSetUint(), CE_DetailSetInt(), CE_DetailSetDouble(), CE_DetailSetString(), CE_DetailSetTriple().