Class: IOTTagsComponent

IOTTagsComponent

This class extends the Component class and provides functionalities for creating, displaying, and managing IoT tags in IFC models.

new IOTTagsComponent(components, ui)

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 26

Constructs an IOTTagsComponent instance.

Name Type Description
components Components

The Components instance associated with this component.

ui GoIFCUI

The UI component associated with GoIFCComponents.

Extends

  • undefined

Methods

activate()

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1648

Activates the IOTTagsComponent, enabling its functionalities.

asyncdeactivate()

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1696

Deactivates the IOTTagsComponent, disabling its functionalities.

dismount()

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1808

Cleans up the component by stopping polling intervals and clearing sync intervals.

get(){module:Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts~IOTTagsComponent}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1636

Returns the current instance of IOTTagsComponent.

Returns:
Type Description
module:Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts~IOTTagsComponent The current instance of the component.

getDebugMode(){boolean}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 48

Gets the current debug mode state

Returns:
Type Description
boolean
  • Current debug mode state

getIOTSignals(){Map.<number, NexusDataTagsResponse>}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1531

Retrieves the current map of IoT signals.

Returns:
Type Description
Map.<number, NexusDataTagsResponse> A map of IoT signals keyed by their expressID.

getIOTTag(expressID){Object|undefined}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1560

Retrieves a specific IoT tag by its expressID.

Name Type Description
expressID number

The expressID of the IFC element.

Returns:
Type Description
Object | undefined The IoT tag if found, otherwise undefined.

getIOTTags(){Map.<number, {position: Vector3, tagElement: CSS2DObject, value: number}>}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1545

Retrieves the current map of IoT tags.

Returns:
Type Description
Map.<number, {position: Vector3, tagElement: CSS2DObject, value: number}> A map of IoT tags keyed by their expressID.

hasIOTSignalForElement(expressID, dmdId, signalUID){boolean}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1576

Checks if an IOT signal already exists for a given expressID and signal.

Name Type Description
expressID number

The expressID of the IFC element.

dmdId number

The DMD asset ID.

signalUID string

The signal UID.

Returns:
Type Description
boolean True if the signal exists, false otherwise.

isActive(){boolean}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1476

Checks if the component is active.

Returns:
Type Description
boolean
  • The active status of the component.

repositionIOTSignal(expressID, dmdId, signalUID, newPosition){boolean}

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 1595

Repositions an existing IOT signal to a new location.

Name Type Description
expressID number

The expressID of the IFC element.

dmdId number

The DMD asset ID.

signalUID string

The signal UID.

newPosition Vector3

The new position for the signal.

Returns:
Type Description
boolean True if repositioning was successful, false otherwise.

setDebugMode(enabled)

Interactions/IFC/interact/GoIFCComponents/Components/IOTTagsComponent/index.ts, line 36

Enables or disables debug mode for console logging

Name Type Description
enabled boolean

Whether to enable debug mode