initi.doc/docfiles/providers/managers/models/model.js

118 lines
3.0 KiB
JavaScript

/**
* ### Нода дерева.
*
* Представляет интефрейс для доступа к данным устройства.
*
* Позволяет получить список компонентов модели
*
*
* @class Model
* @memberof Models
*/
function Model() {
/**
*
* @public
* @name static
* @type {Models.Model.static_data}
*/
this.static = new Models.Model.static_data();
/**
*
* @public
* @function address
* @memberof Models.Model
* @returns {v2.address}
*/
this.address = function() {
};
/**
*
* @public
* @function groups
* @memberof Models.Model
* @returns {tools.promise}
*/
this.groups = function() {
};
/**
*
* @public
* @function get_group
* @memberof Models.Model
* @param groupType {v2.model_type}
* @returns {tools.promise(ModelGroup)}
*/
this.get_group = function(groupType) {
};
/**
* #### Загрузка статических переменных для устройства
*
* @example
* // Пример, как получить доступ к статическим переменным устройства.
*
* // Создадим промис для отслеживания результата
* var pr = new tools.promise();
*
* var model_provider = null;
* var model_ref = null;
*
* // запрос по адресу модели в менеджер моделей
* ps.pl.mm().get(_model_addr).then(function (_ref) {
* model_ref = _ref;
* model_provider = _ref.value();
*
* // запрос на получение статических данных
* return model_provider.touch();
* }.bind(this), function (_err) {
* pr.reject({err: 0, sub: _err, message: "error on get model", model_addr: _model_addr});
* }.bind(this)).then(function () {
* pr.resolve({
* is_container: model_provider.static.is_container(),
* componentType: model_provider.static.base_component_type()
* });
* clear();
* }.bind(this), function (_err) {
* clear();
* pr.reject({err: 0, sub: _err, message: "error on get static model data", model_addr: _model_addr});
* }.bind(this));
*
* // После того как будет получен полный результат, необходимо сбросить ссылку
* var clear = function () {
* model_ref.reset();
* model_ref = null;
* model_provider = null;
* };
*
*
* @public
* @function touch
* @memberof Models.Model
* @returns {tools.promise}
*/
this.touch = function() {
};
/**
*
* @public
* @function debug
* @memberof Models.Model
* @param {v2.address} destination
* @param {v2.address} variables
*/
this.debug = function(destination, variables) {
};
}