      import { Ranging } from 'buildthing-ble-sdk'

public class | source

Ranging

Extends:

EventEmitter → Ranging

비콘과의 거리를 계산하고 업데이트를 하는 레인징 서비스를 담당하는 클래스

Constructor Summary

Public Constructor
public	constructor(manager: Manager) 레인징 관련 초기값 설정

Member Summary

Public Members
public	deviceStateMap: Map<id, RangedBeacon> 기기 상태들이 저장되어있는 Map (Key : Device Id, Value : RangedBeacon)
public	regionStateMap: Map<id, RegionRangeState> 리전 상태들이 저장되어있는 Map (Key : Region Id, Value : RegionRangeState)

Method Summary

Public Methods
public	addDeviceMeasurement(device: *)
public	addRegion(region: Region): RegionRangeState 레인징 하는 새로운 리전을 추가하는 함수
public	clear() 레인징 하는 모든 리전을 제거 하는 함수
public	emitRangeBeacons() 레인징 상태를 ranged 이벤트에 해당 리전을 넘겨주는 함수
public	getMatchedRegions(beacon: Beacon): Region[] 레인징 하고있는 리전중에 스캔된 비콘과 맞는 리전이 있는지 확인해서 해당 리전들을 배열 형태로 리턴하는 함수
public	getRangedRegionState(): Map<id, RegionRangeState> 현재 레인징 하고 있는 리전과 리전 레인징 상태를 map 형태로 가져오는 함수
public	getRegionSize(): number 레인징 하고있는 리전의 수 를 가져오는 함수
public	getRegions(): Region[] 현재 레인징 하고 있는 리전을 배열 형태로 가져오는 함수
public	removeRegion(region: Region): boolean 레인 하는 리전에서 기존 리전을 제거 하는 함수
public	setRangedRegionState(regionStateMap: Map<id, RegionRangeState>) 레인징 하는 리전 상태값을 전달받은 값으로 초기화 하는 함수
public	updateDeviceMeasurement()
public	updateRangeState(beacon: Beacon) 레인징 하고있는 리전들의 상태를 업데이트 하는 함수

Inherited Summary

From class EventEmitter
public	events: Object 등록된 이벤트 Set 을 저장 할 객체
public	emit(eventName: string, args: Object) 이벤트를 발생시켜 해당 이벤트에 등록된 이벤트 콜백 함수를 호출 하는 함수
public	off(eventName: string, fn: function) 전달받은 이벤트 명 과 이벤트 콜백함수 통해서 이벤트 Set 에서 이벤트 콜백 함수를 제거하는 함수
public	on(eventName: string, fn: function) 전달받은 이벤트 명으로, 전달받은 이벤트 콜백 함수를 등록하는 함수
public	once(eventName: string, fn: function) 이벤트가 발생한 경우 한번만 호출되는 이벤트 콜백 함수를 등록 하는 함수

Public Constructors

public constructor(manager: Manager) source

레인징 관련 초기값 설정

Override:

EventEmitter#constructor

Params:

Name	Type	Attribute	Description
manager	Manager		레인징을 사용하는 매니저 인스턴스

Public Members

public deviceStateMap: Map<id, RangedBeacon> source

기기 상태들이 저장되어있는 Map (Key : Device Id, Value : RangedBeacon)

public regionStateMap: Map<id, RegionRangeState> source

리전 상태들이 저장되어있는 Map (Key : Region Id, Value : RegionRangeState)

Public Methods

public addDeviceMeasurement(device: *) source

Params:

Name	Type	Attribute	Description
device	*

public addRegion(region: Region): RegionRangeState source

레인징 하는 새로운 리전을 추가하는 함수

Params:

Name	Type	Attribute	Description
region	Region		추가하려는 리전

Return:

RegionRangeState

새로운 리전의 regionRangeState 값.

public clear() source

레인징 하는 모든 리전을 제거 하는 함수

public emitRangeBeacons() source

레인징 상태를 ranged 이벤트에 해당 리전을 넘겨주는 함수

Emit:

ranged

이벤트와 해당 rangingData 을 emit 한다.

public getMatchedRegions(beacon: Beacon): Region[] source

레인징 하고있는 리전중에 스캔된 비콘과 맞는 리전이 있는지 확인해서 해당 리전들을 배열 형태로 리턴하는 함수

Params:

Name	Type	Attribute	Description
beacon	Beacon		스캔된 비콘

Return:

Region[]

해당 비콘이 있는 리전 배열

public getRangedRegionState(): Map<id, RegionRangeState> source

현재 레인징 하고 있는 리전과 리전 레인징 상태를 map 형태로 가져오는 함수

Return:

Map<id, RegionRangeState>

현재 모니터링 하고 있는 리전과 리전 모니터링 상태

public getRegionSize(): number source

레인징 하고있는 리전의 수 를 가져오는 함수

Return:

number

레인징 하고있는 리전의 수

public getRegions(): Region[] source

현재 레인징 하고 있는 리전을 배열 형태로 가져오는 함수

Return:

Region[]

현재 레인징 하고 있는 리전을 배열

public removeRegion(region: Region): boolean source

레인 하는 리전에서 기존 리전을 제거 하는 함수

Params:

Name	Type	Attribute	Description
region	Region		제거 하려는 리전

Return:

boolean

제거 했을경우 true, 존재하지 않으면 false

public setRangedRegionState(regionStateMap: Map<id, RegionRangeState>) source

레인징 하는 리전 상태값을 전달받은 값으로 초기화 하는 함수

Params:

Name	Type	Attribute	Description
regionStateMap	Map<id, RegionRangeState>		레인징 하는 리전 상태

public updateDeviceMeasurement() source

public updateRangeState(beacon: Beacon) source

레인징 하고있는 리전들의 상태를 업데이트 하는 함수

Params:

Name	Type	Attribute	Description
beacon	Beacon		발견된 비콘