Class SensorGroup

Represents a group of sensors.

Hierarchy

SensorGroup

Index

Constructors

Accessors

channel elements id name sensors

Methods

addElementById addElementByInternalId addSensor cleanup findSensorByName getState remove removeElement

Constructors

constructor

new SensorGroup(sensorManager: SensorManager, _channel: SensorChannel, _id: Int64, _name: string): SensorGroup
Parameters
- sensorManager: SensorManager
- _channel: SensorChannel
- _id: Int64
- _name: string
Returns SensorGroup
- Defined in sensors/sensors.ts:120

Accessors

channel

get channel(): SensorChannel
Gets the channel of the sensor group.

Returns SensorChannel
- Defined in sensors/sensors.ts:169

elements

get elements(): ElementInfo[]
Gets the elements of the sensor group.

Returns ElementInfo[]
- Defined in sensors/sensors.ts:176

id

get id(): Int64
Gets the ID of the sensor group.

Returns Int64
- Defined in sensors/sensors.ts:162

name

get name(): string
Gets the name of the sensor group.

Returns string
- Defined in sensors/sensors.ts:190
set name(name: string): void
Sets the name of the sensor group.
Parameters
- name: string
Returns void
- Defined in sensors/sensors.ts:197

sensors

get sensors(): Sensor[]
Gets the sensors of the sensor group.

Returns Sensor[]
- Defined in sensors/sensors.ts:183

Methods

addElementById

addElementById(elementId: Int64): Promise<boolean>
Adds an element to the group by its element ID.
Parameters
- elementId: Int64
Returns Promise<boolean>
- Defined in sensors/sensors.ts:236

addElementByInternalId

addElementByInternalId(internalId: Int64): Promise<boolean>
Adds an element to the group by its internal ID.
Parameters
- internalId: Int64
Returns Promise<boolean>
- Defined in sensors/sensors.ts:219

addSensor

addSensor(name: string, point: Vector3D, value: number): Promise<Sensor>
Adds a sensor to the group.
Parameters
- name: string
- point: Vector3D
- value: number
Returns Promise<Sensor>
- Defined in sensors/sensors.ts:204

cleanup

cleanup(sensors?: boolean, elements?: boolean): Promise<void>
Cleans up the sensor group by removing sensors and/or elements.
Parameters
- sensors: boolean = true
- elements: boolean = true
Returns Promise<void>
- Defined in sensors/sensors.ts:285

findSensorByName

findSensorByName(sensorName: string): Sensor
Finds a sensor by its name.
Parameters
- sensorName: string
Returns Sensor
- Defined in sensors/sensors.ts:127

getState

getState(): SensorGroupState
Gets the state of the sensor group.

Returns SensorGroupState
- Defined in sensors/sensors.ts:136

remove

remove(removeFromGroupsArray?: boolean): Promise<boolean>
Removes the sensor group.
Parameters
- removeFromGroupsArray: boolean = true
Returns Promise<boolean>
- Defined in sensors/sensors.ts:269

removeElement

removeElement(internalId: Int64): Promise<boolean>
Removes an element from the group.
Parameters
- internalId: Int64
Returns Promise<boolean>
- Defined in sensors/sensors.ts:253