This commit is contained in:
Aleksey Chichenkov 2019-03-18 16:14:33 +03:00
parent 223d49bfe6
commit 89ce45f653
13 changed files with 113 additions and 6 deletions

View File

@ -1,4 +1,6 @@
/** /**
* ### Конфиг платформы
*
* Интерфейс предоставляющий доступ к конфигурационным данным платформы, у которой был произведен запрос. * Интерфейс предоставляющий доступ к конфигурационным данным платформы, у которой был произведен запрос.
* *
* ```bash * ```bash

View File

@ -1,4 +1,6 @@
/** /**
* ### Каталог источников данных
*
* Менеджер предназначеный для работы с датасорсами. * Менеджер предназначеный для работы с датасорсами.
* *
* ```bash * ```bash

View File

@ -1,6 +1,11 @@
/** /**
* Описание типа компонента * Описание типа компонента
* *
* <br>
* Связанные объекты:
*
* - {@link GroupTypes GroupTypes} - менеджер типов групп
*
* @class GroupType * @class GroupType
* @memberof GroupTypes * @memberof GroupTypes
*/ */

View File

@ -1,5 +1,5 @@
/** /**
* #### Менеджер типов групп. * ### Группы (Компоненты).
* *
* Этот менеджер позволяет запросить данные по типу компонента. * Этот менеджер позволяет запросить данные по типу компонента.
* *
@ -7,6 +7,12 @@
* // доступ * // доступ
* ps.pl.gtm * ps.pl.gtm
* ``` * ```
*
* <br>
* Связанные объекты:
*
* - {@link GroupTypes.GroupType GroupType} - Тип группы
*
* @group manager * @group manager
* @namespace GroupTypes * @namespace GroupTypes
*/ */

View File

@ -0,0 +1,47 @@
/**
* Описание типа компонента
*
* @class AlarmType
* @memberof Models
*/
function AlarmType() {
/**
* Позволяет получить все атрибуты типа аларма.
*
* @public
* @function attributes
* @memberof Models.AlarmType
* @returns {v2.map(v2.string, v2.vc)}
*/
this.attributes = function () {
};
/**
* Описание типа аларма (уже в нужной локали)
*
* @public
* @function description
* @memberof Models.AlarmType
* @returns {v2.string}
*/
this.description = function () {
};
/**
* Тип паблишера, который будет создаваться для данного компонента.
*
* Этот метод предназначен для гридов в поисках по компонентам.
*
* @public
* @function publisher_type
* @memberof Models.AlarmType
* @returns {v2.model_type}
*/
this.publisher_type = function () {
};
}

View File

@ -1,4 +1,13 @@
/** /**
* ### Группы моделей (Компоненты)
*
* <br>
* Связанные объекты:
*
* - {@link Models.Model.Groups.Group Group} - Группа модели (тип компонента)
* - {@link Models.Model.Groups.BaseGroup BaseGroup} - Базовая группа (есть у любого девайса - **baseComponent**)
* - {@link Models.Model Model} - Модель (устройство, девайс). Доступ к данным модели
* - {@link Models Models} - Менеджер моделей.
* *
* @group manager * @group manager
* @class Groups * @class Groups

View File

@ -1,5 +1,5 @@
/** /**
* Менеджер моделей. * ### Менеджер моделей.
* *
* Представляет собой интерфейс для доступа ко всем моделям * Представляет собой интерфейс для доступа ко всем моделям
* *
@ -9,6 +9,14 @@
* // доступ * // доступ
* ps.pl.mm * ps.pl.mm
* ``` * ```
*
*
* <br>
* Связанные объекты:
*
* - {@link Models.Model Model} - Модель (устройство, девайс). Доступ к данным модели
* - {@link Models.AlarmType AlarmType} - Тип аварии(аларма). Предоставляет доступ к данным типа аварии.
*
* @group manager * @group manager
* @namespace Models * @namespace Models
* @extends manager * @extends manager
@ -55,4 +63,17 @@ function Models() {
}; };
/**
* #### Загрузит все объекты, которые попадают в указанную область.
*
* @public
* @function get_alarm_type
* @returns {tools.promise(Models.AlarmType)}
* @memberof Models
*/
this.get_alarm_type = function () {
};
} }

View File

@ -1,10 +1,16 @@
/** /**
* ### Нода дерева. * ### Модель (устройство, девайс).
* *
* Представляет интефрейс для доступа к данным устройства. * Представляет интефрейс для доступа к данным устройства.
* *
* Позволяет получить список компонентов модели * Позволяет получить список компонентов модели
* *
* <br>
* Связанные объекты:
*
* - {@link Models Models} - Менеджер моделей.
* - {@link Models.Model.Groups Groups} - Группы моделей (список компонентов, которые есть у модели).
* - {@link Models.Model.static static} - Статические данные модели
* *
* @class Model * @class Model
* @memberof Models * @memberof Models

View File

@ -1,5 +1,7 @@
/** /**
* Менеджер для доступа к типам моделей * ### Типам моделей
*
* Менеджер для доступа.
* *
* Это системный менеджер, и нужен для работы {@link Models.Model.Groups.Group ModelGroup} * Это системный менеджер, и нужен для работы {@link Models.Model.Groups.Group ModelGroup}
* ```bash * ```bash

View File

@ -1,5 +1,5 @@
/** /**
* Менеджер паблишеров. * ### Менеджер паблишеров.
* <br> * <br>
* <br> * <br>
* **Доступ:** * **Доступ:**

View File

@ -1,4 +1,6 @@
/** /**
* ### Серверные переводы
*
* Менеджер доступа до переводов, которые предоставляет сервер. * Менеджер доступа до переводов, которые предоставляет сервер.
* *
* ```bash * ```bash

View File

@ -7,6 +7,11 @@
* *
* Деревья представляют собой следующую иерархию наследования * Деревья представляют собой следующую иерархию наследования
* *
* ```bash
* // доступ
* ps.pl.tm
* ```
*
* <br> * <br>
* *
* {@link Trees.GlobalTree GlobalTree} - любое дерево (обладает возможностью открывать свою иерархию) * {@link Trees.GlobalTree GlobalTree} - любое дерево (обладает возможностью открывать свою иерархию)

View File

@ -1,5 +1,5 @@
/** /**
* Интерфейс, который предоставляет доступ к данным групп, ваыф * ### Интерфейс, который предоставляет доступ к данным групп, ваыф
* *
* ```bash * ```bash
* // доступ * // доступ