SiteCalibration
Extends
AbstractEntity
class SiteCalibration extends AbstractEntity
Static
create
static create(json = null): SiteCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Returns:
Type: SiteCalibration
getName
static getName(): "SiteCalibration"
Returns:
Type: constant ("SiteCalibration": string)
Constructor
constructor
constructor(json = null): SiteCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Properties
device
| Type | Default | Description |
|---|---|---|
| Reference<Device> | new Reference('Device', null) |
floor_calibrations
| Type | Default | Description |
|---|---|---|
| Collection<FloorCalibration> | new Collection('FloorCalibration', null) |
id
| Type | Default | Description |
|---|---|---|
| null | int | symbol | null | The entity identifier |
metadata
| Type | Default | Description |
|---|---|---|
| Map | new Map() |
site
| Type | Default | Description |
|---|---|---|
| Reference<Site> | new Reference('Site', null) |
start_floor
| Type | Default | Description |
|---|---|---|
| null | int | null |
start_point_floor
| Type | Default | Description |
|---|---|---|
| null | int | null |
start_point_position
| Type | Default | Description |
|---|---|---|
| Vector | new Vector() |
Methods
toJSON
toJSON(): object
Returns:
Type: object (see properties bellow)
| Name | Type | Description |
|---|---|---|
| device | int | symbol | null | |
| floor_calibrations | Array< {id: int | symbol, position: int} > | |
| id | int | symbol | null | |
| metadata | object | |
| site | int | symbol | null | |
| start_floor | int | null | |
| start_point_floor | int | null | |
| start_point_position | {x: number, y: number, z: number} |
fromJSON
fromJSON(json: object): SiteCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | object | Yes | - | |
| json.device | int | symbol | null | No | null | |
| json.floor_calibrations | Array< {id: int | symbol, position: int} > | No | [] | |
| json.id | int | symbol | null | No | null | |
| json.metadata | object | No | {} | |
| json.site | int | symbol | null | No | null | |
| json.start_floor | int | null | No | null | |
| json.start_point_floor | int | null | No | null | |
| json.start_point_position | {x: number, y: number, z: number} | No | {x: 0, y:, z: 0} |
Returns:
Returns this
clone
clone(): SiteCalibration
Returns:
A new deep copy
Type: SiteCalibration