Documentation

Module: xcf/model/Device

new (require("xcf/model/Device"))()

Source:
xcf/model/Device.js

Members

<inner> state :module:xide/types~DEVICE_STATE

Type:
  • module:xide/types~DEVICE_STATE
Source:
xcf/model/Device.js
See:
  • module:xide/types/DEVICE_STATE

Methods

<inner> getBlockScope()

Returns the block scope of the a driver's instance

Source:
xcf/model/Device.js
Returns:
Type
module:xblox/model/Scope

<inner> getDriver()

Return the driver model item

Source:
xcf/model/Device.js
Returns:
Type
module:xcf/model/Driver | null

<inner> getDriverInstance()

Returns the driver instance

Source:
xcf/model/Device.js
Returns:
Type
model:xcf/driver/DriverBase

<inner> getMetaValue(title)

Return a value by field from the meta database

Parameters:
Name Type Description
title
Source:
xcf/model/Device.js
Returns:
Type
string | int | boolean | null

<inner> getStateIcon(state)

Return the internal state icon

Parameters:
Name Type Description
state
Source:
xcf/model/Device.js
Returns:
Type
string | null

<inner> setMetaValue(title)

Set a value in the meta database

Parameters:
Name Type Description
title string

The name of the CI
Source:
xcf/model/Device.js
Returns:
Type
void | null

<inner> setState(state, silent)

Set the state

Parameters:
Name Type Description
state
silent
Source:
xcf/model/Device.js

Module: xcf/model/Device

Model for a device. It extends the base model class
and acts a source.

new (require("xcf/model/Device"))()

Source:
xcf/model/Device.js

Extends

  • module:xide/mixins/EventedMixin
  • module:xide/data/Model
  • module:xide/data/Source

Members

<inner> state :module:xide/types~DEVICE_STATE

Type:
  • module:xide/types~DEVICE_STATE
Source:
xcf/model/Device.js
See:
  • module:xide/types/DEVICE_STATE

Methods

<inner> getBlockScope()

Returns the block scope of the a driver's instance

Source:
xcf/model/Device.js
Returns:
Type
module:xblox/model/Scope

<inner> getDriver()

Return the driver model item

Source:
xcf/model/Device.js
Returns:
Type
module:xcf/model/Driver | null

<inner> getDriverInstance()

Returns the driver instance

Source:
xcf/model/Device.js
Returns:
Type
model:xcf/driver/DriverBase

<inner> getMetaValue(title)

Return a value by field from the meta database

Parameters:
Name Type Description
title
Source:
xcf/model/Device.js
Returns:
Type
string | int | boolean | null

<inner> getStateIcon(state)

Return the internal state icon

Parameters:
Name Type Description
state
Source:
xcf/model/Device.js
Returns:
Type
string | null

<inner> setMetaValue(title)

Set a value in the meta database

Parameters:
Name Type Description
title string

The name of the CI
Source:
xcf/model/Device.js
Returns:
Type
void | null

<inner> setState(state, silent)

Set the state

Parameters:
Name Type Description
state
silent
Source:
xcf/model/Device.js