module:nmodule/driver/rc/wb/mgr/PointMgrModel

module:nmodule/driver/rc/wb/mgr/PointMgrModel

new (require("nmodule/driver/rc/wb/mgr/PointMgrModel"))(params)

Description:

  • API Status: Development

    A MgrModel type for a PointMgr derived type as an agent on a driver's
    BPointDeviceExt type.

Source:
Extends:
  • module:nmodule/webEditors/rc/wb/mgr/model/MgrModel
Parameters:
Name Type Description
params Object

object containing the constructor parameters

Properties
Name Type Attributes Description
component baja.Component

the component containing the points to
be shown in the manager, typically a device's point ext or a point folder.
folderType string | Type <optional>

optional parameter indicating the folder
type for the manager. This will be used by the 'new folder' command.

Extends

  • module:nmodule/webEditors/rc/wb/mgr/model/MgrModel

Methods

getNavDisplayName()

Description:

  • Get the display name from the display name of the root component container.
    This is used for the title of the tab in the HTML5 hx profile.

Source:

getProxyExtType() → {string|Type}

Description:

  • Return the proxy extension type used by the concrete driver implementation. This
    is used by the default implementation of the #newInstance() function.

Source:
Returns:
Type
string | Type

makeRow(subject) → {module:nmodule/webEditors/rc/wb/table/model/Row}

Description:

  • Make a row for the given subject with the appropriate icon for the row. Overrides
    TableModel.makeRow().

Source:
Parameters:
Name Type Description
subject

The subject of the row. Should be a point or folder instance.
Returns:
Type
module:nmodule/webEditors/rc/wb/table/model/Row

newInstance(typeInfo) → {baja.Value|Promise}

Description:

  • Override point to customize how new instances of the selected type spec
    are instantiated. The default implementation will create a point and proxy ext
    using the type specified by the getProxyExtType() function.

Source:
Parameters:
Name Type Description
typeInfo module:nmodule/webEditors/rc/wb/mgr/MgrTypeInfo
Returns:
Type
baja.Value | Promise

(static) addBooleanPointTypes(writable, types)

Description:

  • Add the boolean point types to the given array. If the writable parameter
    is false, the writable boolean type will not be added.

Source:
Parameters:
Name Type Description
writable boolean

If true, will add the BooleanWritable type to the array.
types Array

An array of that will have the numeric types appended.
If not specified, a new array will be created and returned.
Returns:

The provided array or a new one containing the appropriate boolean point types.

(static) addEnumPointTypes(writable, types)

Description:

  • Add the standard enum point types to the given array. If the writable parameter
    is false, the writable enum type will not be added.

Source:
Parameters:
Name Type Description
writable boolean

If true, will add the EnumWritable type to the array.
types Array

An array of that will have the numeric types appended.
If not specified, a new array will be created and returned.
Returns:

The provided array or a new one containing the appropriate enum point types.

(static) addNumericPointTypes(writable, types)

Description:

  • Add the standard numeric point types to the given array. If the writable parameter
    is false, the writable numeric type will not be added.

Source:
Parameters:
Name Type Description
writable boolean

If true, will add the NumericWritable type to the array.
types Array

An array of that will have the numeric types appended.
If not specified, a new array will be created and returned.
Returns:

The provided array or a new one containing the appropriate numeric point types.

(static) addStringPointTypes(writable, types)

Description:

  • Add the standard numeric point types to the given array. If the writable parameter
    is false, the writable numeric type will not be added.

Source:
Parameters:
Name Type Description
writable boolean

If true, will add the StringWritable type to the array.
types Array

An array of that will have the numeric types appended.
If not specified, a new array will be created and returned.
Returns:

The provided array or a new one containing the appropriate numeric point types.

(static) getDefaultNewTypes() → {Promise.<Array.<module:nmodule/webEditors/rc/wb/mgr/MgrTypeInfo>>}

Description:

  • Return MgrTypeInfo instances for the default new types for a point manager.
    This includes writable and non-writable versions of the four basic point
    data types (boolean, numeric, enum, string).

Source:
Returns:
Type
Promise.<Array.<module:nmodule/webEditors/rc/wb/mgr/MgrTypeInfo>>