Commit 1aafec6e authored by Pavel Vainerman's avatar Pavel Vainerman

(docs): ещё немного подправил документацию по uniset-codegen

parent 7cefdd10
......@@ -130,9 +130,9 @@
Для работы с сообщениями существует ряд правил:
- сообщения должны посылаться при помощи специальной (сгенерированной) функций
\b setMsg( UniSetTypes::ObjectId code, bool state ) или alarm( UniSetTypes::ObjectId code, bool state ).
Для передачи сообщения необходим вызов c параметром \b state="true".
Для передачи сообщения необходим вызов c параметром \b state=true.
- Сообщения "автоматически" сбрасываются в "0" через \b resetMsgTime (настраиваемое в конф. секции), поэтому
вызывать функции с \b state="false" нет смысла.
вызывать функции с \b state=false нет смысла.
\section pg_Codegen_Variables Секция <variables>
В данной секции можно перечислить \b переменные разных типов, для которых будет сгенерирован код по их "инициализации"
......@@ -146,7 +146,7 @@
- \b min - минимальное разрешенное значение
- \b max - максимальное разрешенное значение
- \b default - значение по умолчанию (при инициализации)
- \b no_range_exception - не генерировать исключение в случае выхода переменной за указанный диапазон (min или max).
- \b no_range_exception - не генерировать исключение в случае выхода переменной за указанный диапазон (\b min или \b max).
Помимо этого в самой секции \<variables> можно указать свойство \b arg_prefix="...", которое используется при инициализации
при помощи аргументов командной строки.
......@@ -157,7 +157,8 @@
if( varname.empty() )
varname = 'default'
\endcode
Где \a it.getProp() - получение значения из соответствующей настроечной секции в конфигурационном файле (см. \ref pg_Codegen_Configuration)
Где \a it.getProp() - получение значения из соответствующей настроечной секции в конфигурационном файле (см. \ref pg_Codegen_Configuration).
Из кода вида, что приоритетным является аргумент командной строки, потом значение из конф. файла и только потом \a default.
Если указаны поля \b min или \b max происходит проверка значения (после инициализации) на соответсвие указанному диапазону.
По умолчанию, при выходе за диапазон, генериурется исключение. Но если указано \b no_range_exception="1",
......@@ -277,13 +278,11 @@
..._SOURCES= MyClass_SK.cc ...
MyClass_SK.cc: myclass.src.xml
@UNISET_CODEGEN@ --ask -n MyClass --no-main myclass.src.xml
@UNISET_CODEGEN@ -n MyClass --no-main myclass.src.xml
\endcode
В этом примере
- \b myclass.src.xml - это файл с описанием переменных
- \b --no-main - отключает генерирование "запускающего" файла (функция main)
- \b -n - опредеяет название файлов для сгенерированного класса. В данном случае будут сгенерированы \a MyClass_SK.h и \a MyClass_SK.cc
- \b --ask - генерировать код на основе шаблона "заказа датчиков" (см. \ref pg_Codegen_Templ_Ask)
*/
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