Commit 170eb8a6 authored by Pavel Vainerman's avatar Pavel Vainerman

(docs): заментировал старую документацию

parent be3abcfc
...@@ -13,14 +13,14 @@ ...@@ -13,14 +13,14 @@
- \ref sec_Cnpt_Process - \ref sec_Cnpt_Process
\section sec_Cnpt_Object Объект \section sec_Concept_Object Объект
В разных местах описаний, в зависимости от контекста, В разных местах описаний, в зависимости от контекста,
под "объектом" подразумевается либо объект класса так или иначе наследующегося под "объектом" подразумевается либо объект класса так или иначе наследующегося
от базового класса библиотеки UniSetObject, либо от базового класса библиотеки UniSetObject, либо
некий концептуальный программный объект способный некий концептуальный программный объект способный
получать и обрабатывать сообщения. получать и обрабатывать сообщения.
\section sec_Cnpt_ObjectTypes Основные типы объектов \section sec_Concept_ObjectTypes Основные типы объектов
В библиотеке произведено условное деление на следующие типы объектов: В библиотеке произведено условное деление на следующие типы объектов:
- (простые) объекты - наследуются от класса UniSetObject - (простые) объекты - наследуются от класса UniSetObject
- контроллеры - являются наследниками класса IOController - контроллеры - являются наследниками класса IOController
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
- узлы - в строгом смысле, не являются объектами, - узлы - в строгом смысле, не являются объектами,
но обладают уникальным идентификатором. но обладают уникальным идентификатором.
\section sec_Cnpt_Message Сообщения \section sec_Concept_Message Сообщения
Вся система взаимодейтсвия между объектами в основном Вся система взаимодейтсвия между объектами в основном
построена на использовании сообщений (передаваемых построена на использовании сообщений (передаваемых
путём удаленного вызова специальных функций, путём удаленного вызова специальных функций,
...@@ -53,9 +53,9 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage. ...@@ -53,9 +53,9 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage.
\endcode \endcode
\section sec_Cnpt_ObjectId Идентификатор объекта \section sec_Concept_ObjectId Идентификатор объекта
Каждый объект, которому необходимо взаимодействовать с другими объектами Каждый объект, которому необходимо взаимодействовать с другими объектами
(в том числе датчиками см. \ref sec_Cnpt_Sensor) должен обладать уникальным (в том числе датчиками см. \ref sec_Concept_Sensor) должен обладать уникальным
идентификатором. В качестве идентификатора выступает любое число типа \b UniSetTypes::ObjectId. идентификатором. В качестве идентификатора выступает любое число типа \b UniSetTypes::ObjectId.
Зарезервированным числом является UniSetTypes::DefaultObjectId. Зарезервированным числом является UniSetTypes::DefaultObjectId.
Минимальное требование - это уникальность в рамках одного узла. Минимальное требование - это уникальность в рамках одного узла.
...@@ -170,9 +170,9 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage. ...@@ -170,9 +170,9 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage.
не сложными скриптами). не сложными скриптами).
\section sec_Cnpt_Repository Репозиторий объектов \section sec_Concept_Repository Репозиторий объектов
\section sec_Cnpt_Sensor Датчик \section sec_Concept_Sensor Датчик
Датчик - это одно из базовых понятий при построении систем на основе libuniset. Датчик - это одно из базовых понятий при построении систем на основе libuniset.
Датчик - это информационная единица. Практически любая информация Датчик - это информационная единица. Практически любая информация
(о событиях, о состоянии того или иного процесса, объекта, сообщение оператору и т.п.) (о событиях, о состоянии того или иного процесса, объекта, сообщение оператору и т.п.)
...@@ -195,7 +195,7 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage. ...@@ -195,7 +195,7 @@ UniSetTypes::Message::TheLastFieldOfTypeOfMessage.
на передачу цифровой информации (не текстовой). на передачу цифровой информации (не текстовой).
Например CAN, ModbusRTU, ModbusTCP и т.п. Например CAN, ModbusRTU, ModbusTCP и т.п.
\section sec_Cnpt_Process Процесс \section sec_Concept_Process Процесс
Под процессом в документации чаще всего подразумевается системный Под процессом в документации чаще всего подразумевается системный
процесс (запущенная программа) выполняющий те или иные функции управления процесс (запущенная программа) выполняющий те или иные функции управления
и обменивающийся для этого с другими процессами сообщениями или и обменивающийся для этого с другими процессами сообщениями или
......
/*! /* OBSOLETE DOC!!!
\page ConfigurationPage Конфигурирование системы \page ConfigurationPage Конфигурирование системы
- \ref ConfigurationPage_secCommon - \ref ConfigurationPage_secCommon
...@@ -16,13 +16,14 @@ ...@@ -16,13 +16,14 @@
функции main. Например так: функции main. Например так:
\code \code
... ...
#include "ObjectsMap.h" #include <Configuration.h>
using namespace UniSetTypes; using namespace UniSetTypes;
int main(int argc, char **argv) int main(int argc, char **argv)
{ {
try try
{ {
conf = new Configuration(argc, (const char**)argv, "configure.xml", (ObjectInfo*)ObjectsMap); uniset_init(argc, argv, "configure.xml");
... ...
... ...
......
...@@ -2,7 +2,9 @@ ...@@ -2,7 +2,9 @@
\page DependsPage Зависимости между датчиками \page DependsPage Зависимости между датчиками
Механизм зависимостей реализован в классе IOController. Механизм зависимостей реализован в классе IOController.
В configure.xml настривается
Пример записи "зависимости" в configure.xml:
\code
<item textname="...." iotype="..." .../> <item textname="...." iotype="..." .../>
<consumers> <consumers>
<consumers> <consumers>
...@@ -11,7 +13,7 @@ ...@@ -11,7 +13,7 @@
<depend name="Sensor2" filter2="val1" /> <depend name="Sensor2" filter2="val1" />
</depends> </depends>
</item> </item>
\endcode
При считывании конф. файла можно задавать фильтры. При считывании конф. файла можно задавать фильтры.
......
...@@ -5,9 +5,7 @@ ...@@ -5,9 +5,7 @@
\section MainSection Оглавление \section MainSection Оглавление
- \ref CommitPage - \ref CommonPage
- \ref page_Concept - \ref page_Concept
- \ref UniSetLibStylePage - \ref UniSetLibStylePage
- \ref DebugPage
*/ */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment