Commit bf2ac945 authored by Pavel Vainerman's avatar Pavel Vainerman

(LogicProcessor): Добавил краткую документацию

parent b3e4804f
......@@ -2,7 +2,7 @@
#define LProcessor_H_
// --------------------------------------------------------------------------
/*! \page pageLogicProcessor Логический процессор
\section sec_lpCommon Общее описание
Логический процессор представляет из себя процесс, который работает по принципу
PLC-контроллеров, выполняя бесконечный цикл:
......@@ -13,7 +13,7 @@
\endcode
При этом "логика" формируется из простых логических элементов:
-# \b "И" \b (AND)
-# \b "ИЛИ" \b (OR)
-# \b "Задержка" \b (Delay)
......@@ -21,7 +21,7 @@
\section sec_lpShema Конфигурирование
Конфигурирование процесса осуществляется при помощи xml-файла задающего
"схему соединения" элементов. Например
"схему соединения" элементов. Например
\code
<Schema>
<text-view>
......@@ -31,8 +31,8 @@
| | |----| |
---- 2 | |--|
|----|TAND3| |
---- | | | |
| | | ----- |
---- | | | |
| | | ----- |
1 --|TOR2| | | 1 ---- -------
2 --| |--- | ---- ---| | | | out
| | | 1 | | 2 |TOR5|-----| Delay |----
......@@ -69,7 +69,7 @@
Блок \b <elements> содержит список элементов участвующих в "логике", каждому из
которых присвоен уникальный id, а также характеристики каждого элемента.
В секции \b <connections> задаютcя собственно соединения.
\par Тэги:
- \b type="ext" - Соединение связанное с внешним датчиком, задаваемым по имени.
- \b type="int" - Внутреннее соединение элементов между собой.
......@@ -79,10 +79,6 @@
- \b toInput=".." - В качестве значения указывается номер "входа" элемента из которого выходит "сигнал".
В текущей реализации в качестве датчиков разрешено использовать только типы DO или DI.
\note Следует иметь ввиду, что схема \b не \b обязательно должна быть \b "СВЯЗАННОЙ"
(все элементы связанны между собой). В файле может содержаться несколько схем внтури тэга \b <Schema>.
Логика исполняется в порядке следования в файле, сверху вниз (в порядке считывания из файла).
*/
// --------------------------------------------------------------------------
#include <map>
......@@ -94,10 +90,10 @@
class LProcessor
{
public:
LProcessor( const std::string& name="" );
LProcessor();
virtual ~LProcessor();
virtual void execute( const string& lfile );
virtual void execute( const string lfile );
protected:
......@@ -133,9 +129,6 @@ class LProcessor
UniversalInterface ui;
int sleepTime;
int smReadyTimeout; /*!< время ожидания готовности SM */
std::string logname;
private:
......
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