doc
This commit is contained in:
@@ -2,7 +2,7 @@
|
|||||||
* \ingroup System
|
* \ingroup System
|
||||||
* \~\brief
|
* \~\brief
|
||||||
* \~english External process
|
* \~english External process
|
||||||
* \~russian Внешний процесс
|
* \~russian Внешний процесс
|
||||||
*/
|
*/
|
||||||
/*
|
/*
|
||||||
PIP - Platform Independent Primitives
|
PIP - Platform Independent Primitives
|
||||||
@@ -45,11 +45,11 @@ public:
|
|||||||
|
|
||||||
|
|
||||||
//! \~english Returns last attached execution exit code
|
//! \~english Returns last attached execution exit code
|
||||||
//! \~russian
|
//! \~russian Возвращает код завершения последнего выполнения
|
||||||
int exitCode() const {return exit_code;}
|
int exitCode() const {return exit_code;}
|
||||||
|
|
||||||
//! \~english Returns current attached execution process ID
|
//! \~english Returns current attached execution process ID
|
||||||
//! \~russian
|
//! \~russian Возвращает ID процесса текущего выполнения
|
||||||
int pID() const;
|
int pID() const;
|
||||||
|
|
||||||
void setGrabInput(bool yes) {g_in = yes;}
|
void setGrabInput(bool yes) {g_in = yes;}
|
||||||
@@ -162,22 +162,27 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn void exec(const PIString & program)
|
//! \fn void exec(const PIString & program)
|
||||||
|
//! \brief
|
||||||
//! \~english Start attached execution "program" without arguments
|
//! \~english Start attached execution "program" without arguments
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
//! \fn void exec(const PIString & program, const PIStringList & args)
|
//! \fn void exec(const PIString & program, const PIStringList & args)
|
||||||
|
//! \brief
|
||||||
//! \~english Start attached execution "program" with arguments "args"
|
//! \~english Start attached execution "program" with arguments "args"
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
//! \fn void terminate()
|
//! \fn void terminate()
|
||||||
|
//! \brief
|
||||||
//! \~english Immediately terminate attached execution
|
//! \~english Immediately terminate attached execution
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
//! \fn bool waitForFinish()
|
//! \fn bool waitForFinish()
|
||||||
|
//! \brief
|
||||||
//! \~english Wait for attached execution finish maximum for 60 seconds
|
//! \~english Wait for attached execution finish maximum for 60 seconds
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
//! \fn bool waitForFinish(int timeout_msecs)
|
//! \fn bool waitForFinish(int timeout_msecs)
|
||||||
|
//! \brief
|
||||||
//! \~english Wait for attached execution finish maximum for "timeout_msecs" milliseconds
|
//! \~english Wait for attached execution finish maximum for "timeout_msecs" milliseconds
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
@@ -186,10 +191,12 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn void execStarted(PIString program)
|
//! \fn void execStarted(PIString program)
|
||||||
|
//! \brief
|
||||||
//! \~english Raise on attached execution start
|
//! \~english Raise on attached execution start
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
//! \fn void execFinished(PIString program)
|
//! \fn void execFinished(PIString program)
|
||||||
|
//! \brief
|
||||||
//! \~english Raise on attached execution finish
|
//! \~english Raise on attached execution finish
|
||||||
//! \~russian
|
//! \~russian
|
||||||
|
|
||||||
|
|||||||
@@ -181,38 +181,47 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn bool start(int timer_delay = -1)
|
//! \fn bool start(int timer_delay = -1)
|
||||||
|
//! \brief
|
||||||
//! \~english Start thread
|
//! \~english Start thread
|
||||||
//! \~russian Запускает поток
|
//! \~russian Запускает поток
|
||||||
|
|
||||||
//! \fn bool startOnce()
|
//! \fn bool startOnce()
|
||||||
|
//! \brief
|
||||||
//! \~english Start thread without internal loop
|
//! \~english Start thread without internal loop
|
||||||
//! \~russian Запускает поток без внутреннего цикла
|
//! \~russian Запускает поток без внутреннего цикла
|
||||||
|
|
||||||
//! \fn bool startOnce(ThreadFunc func)
|
//! \fn bool startOnce(ThreadFunc func)
|
||||||
|
//! \brief
|
||||||
//! \~english Start thread without internal loop
|
//! \~english Start thread without internal loop
|
||||||
//! \~russian Запускает поток без внутреннего цикла
|
//! \~russian Запускает поток без внутреннего цикла
|
||||||
|
|
||||||
//! \fn void stop(bool wait = false)
|
//! \fn void stop(bool wait = false)
|
||||||
|
//! \brief
|
||||||
//! \~english Stop thread
|
//! \~english Stop thread
|
||||||
//! \~russian Останавливает поток
|
//! \~russian Останавливает поток
|
||||||
|
|
||||||
//! \fn void terminate()
|
//! \fn void terminate()
|
||||||
|
//! \brief
|
||||||
//! \~english Strongly stop thread
|
//! \~english Strongly stop thread
|
||||||
//! \~russian Жестко останавливает поток
|
//! \~russian Жестко останавливает поток
|
||||||
|
|
||||||
//! \fn bool waitForStart(int timeout_msecs = -1)
|
//! \fn bool waitForStart(int timeout_msecs = -1)
|
||||||
|
//! \brief
|
||||||
//! \~english Wait for thread start
|
//! \~english Wait for thread start
|
||||||
//! \~russian Ожидает старта потока
|
//! \~russian Ожидает старта потока
|
||||||
|
|
||||||
//! \fn bool waitForFinish(int timeout_msecs = -1)
|
//! \fn bool waitForFinish(int timeout_msecs = -1)
|
||||||
|
//! \brief
|
||||||
//! \~english Wait for thread finish
|
//! \~english Wait for thread finish
|
||||||
//! \~russian Ожидает завершения потока
|
//! \~russian Ожидает завершения потока
|
||||||
|
|
||||||
//! \fn void lock()
|
//! \fn void lock()
|
||||||
|
//! \brief
|
||||||
//! \~english Lock internal mutex
|
//! \~english Lock internal mutex
|
||||||
//! \~russian Блокирует внутренний мьютекс
|
//! \~russian Блокирует внутренний мьютекс
|
||||||
|
|
||||||
//! \fn void unlock()
|
//! \fn void unlock()
|
||||||
|
//! \brief
|
||||||
//! \~english Unlock internal mutex
|
//! \~english Unlock internal mutex
|
||||||
//! \~russian Разблокирует внутренний мьютекс
|
//! \~russian Разблокирует внутренний мьютекс
|
||||||
|
|
||||||
@@ -221,10 +230,12 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn void started()
|
//! \fn void started()
|
||||||
|
//! \brief
|
||||||
//! \~english Raise on thread start
|
//! \~english Raise on thread start
|
||||||
//! \~russian Вызывается при старте потока
|
//! \~russian Вызывается при старте потока
|
||||||
|
|
||||||
//! \fn void stopped()
|
//! \fn void stopped()
|
||||||
|
//! \brief
|
||||||
//! \~english Raise on thread stop
|
//! \~english Raise on thread stop
|
||||||
//! \~russian Вызывается при завершении потока
|
//! \~russian Вызывается при завершении потока
|
||||||
|
|
||||||
|
|||||||
@@ -221,10 +221,12 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn void setInterval(double ms)
|
//! \fn void setInterval(double ms)
|
||||||
|
//! \brief
|
||||||
//! \~english Set timer loop delay in milliseconds
|
//! \~english Set timer loop delay in milliseconds
|
||||||
//! \~russian Установить интервал таймера "ms" миллисекунд
|
//! \~russian Установить интервал таймера "ms" миллисекунд
|
||||||
|
|
||||||
//! \fn bool start()
|
//! \fn bool start()
|
||||||
|
//! \brief
|
||||||
//! \~english Start timer with \a interval() loop delay
|
//! \~english Start timer with \a interval() loop delay
|
||||||
//! \~russian Запустить таймер с интервалом \a interval()
|
//! \~russian Запустить таймер с интервалом \a interval()
|
||||||
//! \~\details
|
//! \~\details
|
||||||
@@ -234,6 +236,7 @@ public:
|
|||||||
//! Запускает таймер с частотой = 1 / msecs Гц
|
//! Запускает таймер с частотой = 1 / msecs Гц
|
||||||
|
|
||||||
//! \fn bool start(double msecs)
|
//! \fn bool start(double msecs)
|
||||||
|
//! \brief
|
||||||
//! \~english Start timer with "msecs" loop delay
|
//! \~english Start timer with "msecs" loop delay
|
||||||
//! \~russian Запустить таймер с интервалом "msecs"
|
//! \~russian Запустить таймер с интервалом "msecs"
|
||||||
//! \~\details
|
//! \~\details
|
||||||
@@ -247,14 +250,17 @@ public:
|
|||||||
//! более 1 кГц
|
//! более 1 кГц
|
||||||
|
|
||||||
//! \fn bool restart()
|
//! \fn bool restart()
|
||||||
|
//! \brief
|
||||||
//! \~english Stop and start timer with \a interval() loop delay
|
//! \~english Stop and start timer with \a interval() loop delay
|
||||||
//! \~russian Остановить и запустить таймер с интервалом \a interval()
|
//! \~russian Остановить и запустить таймер с интервалом \a interval()
|
||||||
|
|
||||||
//! \fn bool stop(bool wait = true)
|
//! \fn bool stop(bool wait = true)
|
||||||
|
//! \brief
|
||||||
//! \~english Stop timer and wait for it finish if "wait"
|
//! \~english Stop timer and wait for it finish if "wait"
|
||||||
//! \~russian Остановить таймер и если "wait" то дождаться остановки
|
//! \~russian Остановить таймер и если "wait" то дождаться остановки
|
||||||
|
|
||||||
//! \fn void clearDelimiters()
|
//! \fn void clearDelimiters()
|
||||||
|
//! \brief
|
||||||
//! \~english Remove all frequency delimiters
|
//! \~english Remove all frequency delimiters
|
||||||
//! \~russian Удаляет все делители частоты
|
//! \~russian Удаляет все делители частоты
|
||||||
|
|
||||||
@@ -263,6 +269,7 @@ public:
|
|||||||
//! \{
|
//! \{
|
||||||
|
|
||||||
//! \fn void tickEvent(void * data, int delimiter)
|
//! \fn void tickEvent(void * data, int delimiter)
|
||||||
|
//! \brief
|
||||||
//! \~english Raise on timer tick
|
//! \~english Raise on timer tick
|
||||||
//! \~russian Вызывается каждый тик таймера
|
//! \~russian Вызывается каждый тик таймера
|
||||||
//! \~\details
|
//! \~\details
|
||||||
|
|||||||
Reference in New Issue
Block a user