Class Sensor

Represents a sensor in the system.

Index

Constructors

Accessors

id group value point name

Methods

getState update remove

Constructors

constructor

new Sensor(
    sensorManager: SensorManager,
    _group: SensorGroup,
    _id: Int64,
    _point: Vector3D,
    _name: string,
    _value: number,
): Sensor
Parameters
- sensorManager: SensorManager
- _group: SensorGroup
- _id: Int64
- _point: Vector3D
- _name: string
- _value: number
Returns Sensor
- Defined in sensors/sensors.ts:12

Accessors

id

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

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

group

get group(): SensorGroup
Gets the group of the sensor.

Returns SensorGroup
- Defined in sensors/sensors.ts:41

value

get value(): number
Gets the value of the sensor.

Returns number
- Defined in sensors/sensors.ts:48

point

get point(): Vector3D
Gets the point of the sensor.

Returns Vector3D
- Defined in sensors/sensors.ts:55

name

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

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

Methods

getState

getState(): SensorState
Gets the state of the sensor.

Returns SensorState
- Defined in sensors/sensors.ts:19

update

update(point?: Vector3D, value?: number): Promise<void>
Updates the sensor with new point and/or value.
Parameters
- Optionalpoint: Vector3D
- Optionalvalue: number
Returns Promise<void>
- Defined in sensors/sensors.ts:76

remove

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