feat: scn docs

ostis-ai · Jan 5, 2024 · 93cc69e · 93cc69e
1 parent b166c25
commit 93cc69e
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,5 @@
-cmake_minimum_required(VERSION 2.8.12)
 project(ostis-metasystem)
+cmake_minimum_required(VERSION 2.8.12)
 
 set(PLATFORM_PATH "${CMAKE_CURRENT_LIST_DIR}/ostis-web-platform")
 set(SC_MACHINE_PATH "${PLATFORM_PATH}/sc-machine")

diff --git a/docs/images/translate_agent_alg_1.png b/docs/images/translate_agent_alg_1.png
diff --git a/docs/images/translate_agent_input.png b/docs/images/translate_agent_input.png
diff --git a/docs/images/translate_agent_output.png b/docs/images/translate_agent_output.png
diff --git a/docs/main.tex b/docs/main.tex
@@ -27,6 +27,7 @@
 \ActivateBG
 \begin{SCn}
 \input{ostis_metasystem}
+\input{translateMainSystemIdtfFromScToFileAgent}
 \input{bibliography/biblio}
 \end{SCn}
 \end{document}
diff --git a/docs/translateMainSystemIdtfFromScToFileAgent.tex b/docs/translateMainSystemIdtfFromScToFileAgent.tex
@@ -0,0 +1,40 @@
+
+\scnheader{Агент перевода основных и системных идентификаторов узлов из sc-памяти в текстовый файл}
+
+\scnidtf{sc-агент трансляции идентификаторов узлов из sc-памяти в текстовый файл}
+\begin{scnrelfromvector}{задачи}
+   \scnitem{поиск системных и основных идентификаторов узлов в sc-памяти}
+   \scnitem{проверка узлов на наличие только одного системного идентификатора и одного основного идентификатора на русском языке}
+   \scnitem{трансляция в текстовый файл является}
+\end{scnrelfromvector}
+\begin{scnrelfrom}{аргументы агента}
+	{пустое множество}
+\end{scnrelfrom}
+\begin{scnrelfrom}{алгоритм}
+{
+	\begin{scnitemize}
+		\item Поиск всех узлов с помощью итератора, который ищет все конструкции вида \scnfileimage[20em]{images/translate_agent_alg_1.png}
+		\item Проверка каждого узла на выполнение трех условий:
+			\begin{scnitemizeii}
+				\item Наличие только одного системного идентификатора.
+				\item Наличие только одного основного русского идентификатора.
+				\item Принадлежность одному из sc-типов узлов.
+			\end{scnitemizeii}
+		\item Если не выполняется одно из условий, то запись данных об узле в файл не выполняется. 
+		\item Если у узла более одного системного идентификатора, то вызывается исключение.
+		\item Если все три условия выполняются, то данные об узле записываются в файл.
+		\item Если произошла ошибка при работе с файлом, вызывается исключение.
+	\end{scnitemize}
+}
+\end{scnrelfrom}
+\begin{scnrelfrom}{ответ агента}
+    {В результате агент создает текстовый файл, в котором в виде словаря формируются структуры.
+     Роль ключа играет основной русский идентификатор, роль значения -- пара, в которой на первом месте стоит системный идентификатор, а на втором -- sc-тип узла.}
+\end{scnrelfrom}
+\begin{scnindent}
+	\begin{scnrelfrom}{пример}
+	{\{\scnqqi{main\_ru\_identifier}, \{\scnqqi{system\_identifier}, \scnqqi{sc\_type}\} \}}
+	\end{scnrelfrom}
+\end{scnindent}
+\scnrelfrom{пример входной конструкции}{\scnfileimage[30em]{images/translate_agent_input.png}}
+\scnrelfrom{пример выходной конструкции}{\scnfileimage[30em]{images/translate_agent_output.png}}