first commit

docfiles/models.js

@@ -0,0 +1,22 @@
+/**
+ * Менеджер моделей.<br>
+ * Представляет собой интерфейс для доступа ко всем моделям<br>
+ * Позволяет по адресу модели, получить на нее ссылку.<br>
+
+ *
+ * @namespace Models
+ */
+function Models() {
+    /**
+     *  Вернет ссылку на модель. В качестве идентификатора следует указать адрес дерева.
+     *
+     * @public
+     * @function get
+     * @param {v2.address} address Адрес модели
+     * @returns {tools.promise.native}
+     * @memberof Models
+     */
+    this.get = function (address) {
+
+    };
+}

docfiles/trees.js

@@ -0,0 +1,40 @@
+/**
+ * Менеджер деревьев.<br>
+ * Представляет собой интерфейс для доступа ко всем деревьям<br>
+ * Позволяет по тегу дерева получить на него ссылку.<br>
+ * На текущий момент содержит в себе: <br>
+ *  - global_tree (Основное дерево)<br>
+ *  - global_attribute_tree (Дерево, которое предоставляет доступ к атрибутам)<br>
+ *  - desktop_tree (Представляет рабочий стол)<br>
+ *  - remote_modules_tree (Представляет собой дерево сборщиков)<br>
+ *  - scheme_tree (Топология)<br>
+ *  - user_attribute_tree (Пользовательские данные)<br>
+ *
+ * @namespace Trees
+ */
+function Trees() {
+    /**
+     *  Вернет ссылку на дерево. В качестве идентификатора следует указать тег дерева.
+     *
+     * @public
+     * @function get
+     * @param {v2.string} treeTag Тег дерева. Например: "rmt", "uat"
+     * @returns {tools.promise.native}
+     * @memberof Trees
+     */
+    this.get = function (treeTag) {
+
+    };
+    /**
+     * Возвращает булевое значение о существовании дерева
+     *
+     * @public
+     * @function is_tree_exist
+     * @param {v2.string} treeTag Тег дерева. Например: "rmt", "uat"
+     * @returns {boolean}
+     * @memberof Trees
+     */
+    this.is_tree_exist = function (treeTag) {
+
+    }
+}

docfiles/trees/desktopTree.js

@@ -0,0 +1,17 @@
+/**
+ * @class DesktopTree
+ * @extends Trees.GlobalAttributeTree
+ * @memberof Trees
+ */
+function DesktopTree() {
+
+}
+
+/**
+ * @class Node
+ * @extends Trees.GlobalAttributeTree.Node
+ * @memberof Trees.DesktopTree
+ */
+function Node() {
+
+}

docfiles/trees/globalAttributeTree.js

@@ -0,0 +1,152 @@
+/**
+ * Отнаследовано от глобального дерева. <br>
+ * Ноды этого дерева имеют доступ к атрибутам
+ *
+ * @class GlobalAttributeTree
+ * @extends Trees.GlobalTree
+ * @memberof Trees
+ */
+function GlobalAttributeTree() {
+
+}
+
+/**
+ * @class Node
+ * @extends Trees.GlobalTree.Node
+ * @memberof Trees.GlobalAttributeTree
+ */
+function Node() {
+    /**
+     * Возвращает список всех атрибутов, включая динамические <br>
+     * <br> Работает через промис.
+     *
+     * @public
+     * @function attributes
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalAttributeTree.Node
+     */
+    this.attributes = function() {
+
+    };
+
+    /**
+     * Возвращает список базовых атрибутов ноды (их нельзя удалить) <br>
+     * <br> Работает через промис.
+     *
+     * @public
+     * @function base_attributes
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalAttributeTree.Node
+     */
+    this.base_attributes = function() {
+
+    };
+
+    /**
+     * Возвращает менеджер атрибутов ноды.
+     *
+     * @public
+     * @function am
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalAttributeTree.Node
+     */
+    this.am = function() {
+
+    };
+}
+
+/**
+ * Интерфейс позволяющей пользователю работать с атрибутами ноды
+ *
+ * @class Attributes
+ * @memberof Trees.GlobalAttributeTree.Node
+ */
+function Attributes() {
+    /**
+     * Возвращает список атрибутов ноды
+     *
+     * @public
+     * @function attributes
+     * @returns {v2.map(v2.string.type, v2.vc.type)}
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.attributes = function() {
+
+    };
+
+    /**
+     * Возвращает список базовых атрибутов ноды
+     *
+     * @public
+     * @function base_attributes
+     * @returns {v2.vc}
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.base_attributes = function() {
+
+    };
+
+    /**
+     * Возвращает ссылку на атрибут ноды
+     *
+     * @public
+     * @function get
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.get = function(attributeName) {
+
+    };
+
+    /**
+     * Проверяет наличие любого атрибута у ноды
+     *
+     * @public
+     * @function is_exist_attribute
+     * @params {v2.string} attributeName
+     * @returns {boolean}
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.is_exist_attribute = function(attributeName) {
+
+    };
+
+    /**
+     * Провеляет наличие базового атрибута у ноды
+     *
+     * @public
+     * @function has_base_attribute
+     * @params {v2.string} attributeName
+     * @returns {boolean}
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.has_base_attribute = function(attributeName) {
+
+    };
+
+    /**
+     * Добавляет динамические атрибуты в ноду
+     *
+     * @public
+     * @function add
+     * @returns {v2.model_type}
+     * @params {v2.vc} attributes список атрибутов
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.add = function(attributes) {
+
+    };
+
+    /**
+     * Удаляет динамические атрибуты из ноды
+     *
+     * @public
+     * @function remove
+     * @returns {v2.model_type}
+     * @params {v2.set(v2.string)} attributes
+     * @memberof Trees.GlobalAttributeTree.Node.Attributes
+     */
+    this.remove = function(attributes) {
+
+    };
+}

docfiles/trees/globalTree.js

@@ -0,0 +1,155 @@
+/**
+ * Глобальное дерево, от которого отнаследованы все остальные. <br>
+ * Копирует идеологию ядра. <br>
+ * Ноды этого дерева имеют доступ только к списку своих потомков.
+ *
+ * @class GlobalTree
+ * @memberof Trees
+ */
+function GlobalTree() {
+    /**
+     * Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.<br>
+     * <br> Работает через промис.
+     *
+     * @public
+     * @function get
+     * @param {v2.integer} nodeId Уникальный идентификатор ноды в дереве
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalTree
+     */
+    this.get = function(nodeId) {
+
+    };
+
+    /**
+     * Позволяет удалить динамический атрибут ноды. <br>
+     * Возвращает булевое значение об операции
+     *
+     * @public
+     * @function remove
+     * @param {v2.string} nodeId Уникальный идентификатор ноды в дереве
+     * @returns {boolean}
+     * @memberof Trees.GlobalTree
+     */
+    this.remove = function(nodeId) {
+
+    };
+
+    /**
+     *  Возвращает адрес дерева в системе
+     *
+     * @public
+     * @function sys_addr
+     * @returns {v2.address}
+     * @memberof Trees.GlobalTree
+     */
+    this.sys_addr = function() {
+
+    };
+}
+
+/**
+ * Нода дерева.<br>
+ * Представляет интефрейс для доступа к данным глобальной ноды в ядре.<br>
+ * Позволяет узнать потомков ноды<br>
+ *
+ * @class Node
+ * @memberof Trees.GlobalTree
+ */
+function Node() {
+    /**
+     * Возвращает ссылку на атрибут ноды.<br>
+     * <br> Работает через промис.
+     *
+     * @public
+     * @function get
+     * @param {v2.string} attributeName Имя атрибута
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalTree.Node
+     */
+    this.get = function(attributeName) {
+
+    };
+
+    /**
+     * Добавляет новый динамический атрибут в ноду.<br>
+     * Ничего не возвращает.
+     *
+     * @public
+     * @function add_node
+     * @param {v2.vc} _attrs
+     * @memberof Trees.GlobalTree.Node
+     */
+    this.add_node = function(_attrs) {
+
+    };
+
+    /**
+     * Возвращает уникальный идентификатор ноды.
+     *
+     * @public
+     * @function id
+     * @returns {v2.integer}
+     * @memberof Trees.GlobalTree.Node
+     */
+    this.id = function() {
+
+    };
+
+    /**
+     * Возвращает список потомков ноды.<br>
+     * <br> Работает через промис.
+     *
+     * @public
+     * @function children
+     * @returns {tools.promise.native}
+     * @memberof Trees.GlobalTree.Node
+     */
+    this.children = function() {
+
+    };
+
+    /**
+     * Доступ к менеджеру детей
+     * @public
+     * @function cm
+     * @returns {Children}
+     * @memberof Trees.GlobalTree.Node
+     */
+    this.cm = function() {
+
+    };
+}
+
+/**
+ * Интерфейс позволяющей пользователю работать с потомками ноды
+ *
+ * @class Children
+ * @memberof Trees.GlobalTree.Node
+ */
+function Children() {
+    /**
+     * Возвращает список потомков ноды
+     *
+     * @public
+     * @function get
+     * @returns {v2.list(v2.integer.type)}
+     * @memberof Trees.GlobalTree.Node.Children
+     */
+    this.children = function(attributeName) {
+
+    };
+
+    /**
+     * Возвращает тип ноды, по ее идентификатору
+     *
+     * @public
+     * @function get_type_by_id
+     * @returns {v2.model_type}
+     * @memberof Trees.GlobalTree.Node.Children
+     */
+    this.get_type_by_id = function(attributeName) {
+
+    };
+}
+

docfiles/trees/remoteModulesTree.js

@@ -0,0 +1,20 @@
+/**
+ * Created by Aleksey Chichenkov <a.chichenkov@initi.ru> on 9/17/18.
+ */
+/**
+ * @class RemoteModulesTree
+ * @extends Trees.GlobalAttributeTree
+ * @memberof Trees
+ */
+function RemoteModulesTree() {
+
+}
+
+/**
+ * @class Node
+ * @extends Trees.GlobalAttributeTree.Node
+ * @memberof Trees.RemoteModulesTree
+ */
+function Node() {
+
+}

docfiles/trees/schemeTree.js

@@ -0,0 +1,17 @@
+/**
+ * @class SchemeTree
+ * @extends Trees.GlobalTree
+ * @memberof Trees
+ */
+function SchemeTree() {
+
+}
+
+/**
+ * @class Node
+ * @extends Trees.GlobalTree.Node
+ * @memberof Trees.SchemeTree
+ */
+function Node() {
+
+}

docfiles/trees/userAttributeTree.js

@@ -0,0 +1,17 @@
+/**
+ * @class UserAttributeTree
+ * @extends Trees.GlobalAttributeTree
+ * @memberof Trees
+ */
+function UserAttributeTree() {
+
+}
+
+/**
+ * @class Node
+ * @extends Trees.GlobalAttributeTree.Node
+ * @memberof Trees.UserAttributeTree
+ */
+function Node() {
+
+}