diff --git a/docfiles/mainpage/main.js b/docfiles/mainpage/main.js index dd46799..8a0233e 100644 --- a/docfiles/mainpage/main.js +++ b/docfiles/mainpage/main.js @@ -36,12 +36,12 @@ * - #### {@link ProvidersSystem Система провайдеров}: * - - #### {@link Trees} - Менеджер для работы с деревьями * - - #### {@link Models} - Менеджер для работы с девайсами(моделями) - * - - #### {@link Publishers} * - - #### {@link ModelTypes} * - - #### {@link GroupTypes} - Менеджер для доступа к типам компонентов + * - - #### {@link LinkTypes} - Менеджер для доступа к типам линков * - - #### {@link EventTypes} - Менеджер для доступа к типам событий * - - #### {@link CoreConfig} - * - - #### {@link CoreErrors} + * - - #### {@link CoreErrors} - интерфейс для получения описания ошибок, которые приходят из ядра * - - #### {@link CoreTranslations} * - - #### {@link UserManager} - Менеджер для доступа к настройкам доступа пользователей * - - #### {@link Publishers} - Менеджер для доступа к настройкам доступа пользователей @@ -135,6 +135,7 @@ * Доступные менеджеры у платформы: * * - {@link GroupTypes} - Менеджер, который позволяет получить данные по типу компонента, определен как **ps.pl.gtm** + * - {@link LinkTypes} - Менеджер, который позволяет получить данные по типу линка, определен как **ps.pl.ltm** * - {@link EventTypes} - Менеджер, который позволяет получить данные по типу события, определен как **ps.pl.etm** * - {@link ModelTypes} - Менеджер, который позволяет узнать о содержимом модели **ps.pl.mtm** * - {@link Models} - Менеджер, для доступа к устройствам, определен как **ps.pl.mm** @@ -185,6 +186,17 @@ * * А так же для отображения атрибутов компонент. * + * + * + *

+ * ### {@link LinkTypes}. Менеджер типов линков. + * + * Позволяет получить данные связанные с типом линка + * + * Этот механизм используется в виджете для связывания компонентов модели. + * + * + * * @name 04 * @mainpage * @memberof mainpage diff --git a/docfiles/providers/interface/platform.js b/docfiles/providers/interface/platform.js index ef0bc7a..9bf13b4 100644 --- a/docfiles/providers/interface/platform.js +++ b/docfiles/providers/interface/platform.js @@ -9,6 +9,7 @@ * * Доступные менеджеры у платформы: * - {@link GroupTypes} - Менеджер, который позволяет получить данные по типу компонента, определен как **gtm** + * - {@link LinkTypes} - Менеджер, который позволяет получить данные по типу линка, определен как **ltm** * - {@link EventTypes} - Менеджер, который позволяет получить данные по типу события, определен как **etm** * - {@link ModelTypes} - Менеджер, который позволяет узнать о содержимом модели **mtm** * - {@link Models} - Менеджер, для доступа к устройствам, определен как **mm** @@ -58,6 +59,15 @@ function Platform() { */ this.gtm = new GroupTypes(); + /** + * + * @public + * @name ltm + * @type {LinkTypes} + * @memberof Platform + */ + this.ltm = new LinkTypes(); + /** * * @public diff --git a/docfiles/providers/managers/core_errors/manager.js b/docfiles/providers/managers/core_errors/manager.js index 1978547..a583232 100644 --- a/docfiles/providers/managers/core_errors/manager.js +++ b/docfiles/providers/managers/core_errors/manager.js @@ -18,10 +18,12 @@ function CoreErrors() { * *
* Пример - * ```javascript + * + * ``` * var error_info = ps.pl.core_errors.get_error(101); * // Вывод => * // {name: "Узел не существует", description: "Узел с требуемым индексом не содержится в дереве п…. Данный код ошибки используется в masterProvider"} + * * ``` * @public * @function get_error diff --git a/docfiles/providers/managers/linkTypes/linkType.js b/docfiles/providers/managers/linkTypes/linkType.js new file mode 100644 index 0000000..3bb3211 --- /dev/null +++ b/docfiles/providers/managers/linkTypes/linkType.js @@ -0,0 +1,106 @@ +/** + * Описание типа компонента + * + *
+ * Связанные объекты: + * + * - {@link LinkTypes LinkTypes} - менеджер типов групп + * + * @class LinkType + * @memberof LinkTypes + */ +function LinkType() { + /** + * + * + * @public + * @function self + * @memberof LinkTypes.LinkType + * @returns {v2.vc} + */ + this.self = function () { + + }; + + /** + * + * @public + * @function parent + * @memberof LinkTypes.LinkType + * @returns {v2.vc} + */ + this.parent = function () { + + }; + + /** + * + * @public + * @function consist + * @memberof LinkTypes.LinkType + * @returns {v2.vc} + */ + this.consist = function () { + + }; + + /** + * Позволяет получить все атрибуты компонента. + * + * @public + * @function attributes + * @memberof LinkTypes.LinkType + * @returns {v2.map(v2.string, v2.vc)} + */ + this.attributes = function () { + + }; + + /** + * Иконка, которой обладает тип компонента + * + * @public + * @function icon + * @memberof LinkTypes.LinkType + * @returns {v2.vc} + */ + this.icon = function () { + + }; + + /** + * Имя компонента (уже в нужной локали) + * + * @public + * @function name + * @memberof LinkTypes.LinkType + * @returns {v2.string} + */ + this.name = function () { + + }; + + /** + * Описание компонента (уже в нужной локали) + * + * @public + * @function description + * @memberof LinkTypes.LinkType + * @returns {v2.string} + */ + this.description = function () { + + }; + + /** + * Является ли данный тип линка направленным + * + * @public + * @function vector + * @memberof LinkTypes.LinkType + * @returns {v2.boolean} + */ + this.vector = function () { + + }; +} \ No newline at end of file diff --git a/docfiles/providers/managers/linkTypes/manager.js b/docfiles/providers/managers/linkTypes/manager.js new file mode 100644 index 0000000..4ce250a --- /dev/null +++ b/docfiles/providers/managers/linkTypes/manager.js @@ -0,0 +1,44 @@ +/** + * ### Тип линка + * + * Этот менеджер позволяет запросить данные по типу линка. + * + * ```bash + * // доступ + * ps.pl.ltm + * ``` + * + *
+ * Связанные объекты: + * + * - {@link LinkTypes.LinkType LinkType} - Тип группы + * + * @group manager + * @namespace LinkTypes + */ +function LinkTypes() { + /** + * Вернет ссылку на Тип линка. + * + * + * Пример + * ``` + * // компонентом может быть например tunnel + * ps.pl.ltm.get(new v2.model_type("tunnel")).then(function(_ref){ + * var provider = _ref.value(); + * // теперь можно работать с провайдером типа линка + * }, function(_err){ + * console.log("произошла ошибка") + * }); + * ``` + * + * @public + * @function get + * @memberof LinkTypes + * @param {v2.model_type} _linkType Тип линка + * @returns {tools.promise(LinkTypes.LinkType)} + */ + this.get = function (_linkType) { + + }; +} \ No newline at end of file