Commit 12454b9d authored by Pavel Vainerman's avatar Pavel Vainerman

(docs): небольшие правки коментариев в коде

(refactoring): небольшие правки
parent 045a4fa6
......@@ -37,8 +37,8 @@
-# \b "Преобразование аналогового значения в логическое" \b (A2D)
Стоит отметить, что по мере развития, процесс стал поддерживать не только логические операции,
а работу с числовыми(аналоговыми) величинами. Например элемент "TA2D".
Но в названии оставлено "Logic".
а работу с числовыми(аналоговыми) величинами. Например элемент "TA2D",
но в названии оставлено "Logic".
\section sec_lpShema Конфигурирование
Конфигурирование процесса осуществляется при помощи xml-файла задающего
......
......@@ -66,7 +66,7 @@ namespace uniset
Диаграмма позволяет задать множество точек. На отрезках между точками используется линейная аппроксимация.
Т.е. часто большую часть времени (во многих задачах) аналоговое значение, меняется в небольших пределах,
Т.к. часто большую часть времени (во многих задачах) аналоговое значение, меняется в небольших пределах,
то добавлен кэш ( rawValue --> calValue ) по умолчанию на 5 значений. Размер кэша можно задать
(поменять или отключить) при помощи Calibration::setCacheSize().
\note Слишком большим задавать кэш не рекомендуется, т.к. тогда поиск по кэшу будет сопоставим с поиском по диаграмме.
......
......@@ -38,7 +38,7 @@
namespace uniset
{
/*!
Конфигуратор системы
Конфигурация системы
\note В случае обнаружения критической ошибки в настроечном файле файле.
Вырабатывает исключение и прекращает работу.
*/
......
......@@ -60,6 +60,9 @@ namespace uniset
Для заказа датчиков предусмотрен ряд функций. На данный момент рекомендуется
пользоватся функцией IONotifyController::askSensor.
\b ConsumerMaxAttempts - максимальное число неудачных попыток послать сообщение "заказчику".
Настраивается в конфигурационном файле. По умолчанию = 5.
\section sec_NC_Consumers Заказчики
В качестве "заказчиков" могут выступать любые UniSet-объекты (UniSetObject),
обладающие "обратным адресом" (идентификатором), по которому присылается
......@@ -123,12 +126,8 @@ namespace uniset
(т.к. используются из разных потоков).
*/
//---------------------------------------------------------------------------
/*! \class IONotifyController
*
* \section AskSensors Заказ датчиков
* ....
* \b ConsumerMaxAttempts - максимальное число неудачных попыток послать сообщение "заказчику".
* Настраивается в конфигурационном файле. По умолчанию = 5.
/*! Реализация IONotifyController.
* см. page_IONotifyController
*/
class IONotifyController:
public IOController,
......
......@@ -33,17 +33,12 @@ namespace uniset
class IORFile
{
public:
IORFile();
static std::string getIOR( const ObjectId id );
static void setIOR( const ObjectId id, const std::string& sior );
static void unlinkIOR( const ObjectId id );
static std::string getFileName( const ObjectId id );
protected:
private:
};
// -----------------------------------------------------------------------------------------
} // end of namespace
......
......@@ -35,7 +35,7 @@ namespace uniset
/*! \class LT_Object
\note '_LT' - это "local timers".
Класс реализующий механиз локальных таймеров. Обеспечивает более надёжную работу
Класс реализующий механизм работы с локальными таймерами. Обеспечивает более надёжную работу
т.к. позволяет обходится без удалённого заказа таймеров у TimеService-а.
Но следует помнить, что при этом объект использующий такие таймеры становится более ресурсоёмким,
т.к. во время работы поток обработки сообщений не "спит", как у обычного UniSetObject-а, а тратит
......
......@@ -31,7 +31,7 @@
namespace uniset
{
/*!
*
* DEPRECATED!
* \todo Проверить функции этого класса на повторную входимость
* \bug При обращении к objectsMap[0].textName срабатывает исключение(видимо какое-то из std).
* Требуется дополнительное изучение.
......
......@@ -36,6 +36,7 @@ namespace uniset
*
* \todo Перейти на shared_ptr, weak_ptr для взаимодействия с ProxyManager
*
* DEPRECATED
*/
class PassiveObject
{
......
......@@ -34,11 +34,12 @@ namespace uniset
/*! \class ProxyManager
* Менеджер пассивных объектов, который выступает вместо них во всех внешних связях...
* В целом связка ProxyManager-PassiveObject является DEPRECATED и лучше строить
* В целом связка ProxyManager-PassiveObject является DEPRECATED и лучше её не использовать.
*
* \todo Перейти на shared_ptr, weak_ptr для взаимодействия с PassiveObject
* своё взаимодействие "менеджер-объекты" исходя из условий "бизнес"-задачи
*
* DEPRECATED
*/
class ProxyManager:
public UniSetObject
......
......@@ -36,7 +36,6 @@ namespace uniset
protected:
virtual void sysCommand( const uniset::SystemMessage* sm ) override;
virtual void sensorInfo( const uniset::SensorMessage* si ) override;
virtual void timerInfo( const uniset::TimerMessage* tm ) override;
SMonitor();
private:
......
......@@ -40,7 +40,7 @@ namespace uniset
virtual ~SViewer();
void view();
void monitor( timeout_t timeoutMS = 500 );
void monitor( timeout_t msec = 500 );
protected:
void readSection(const std::string& sec, const std::string& secRoot);
......@@ -50,7 +50,11 @@ namespace uniset
virtual void updateThresholds( IONotifyController_i::ThresholdsListSeq_var& tlst, uniset::ObjectId oid );
const std::string csec;
void printInfo(uniset::ObjectId id, const std::string& sname, long value, const std::string& supplier,
void printInfo(uniset::ObjectId id,
const std::string& sname,
long value,
const std::string& supplier,
const std::string& txtname, const std::string& iotype);
std::shared_ptr<UInterface> ui;
......
......@@ -31,8 +31,6 @@ namespace uniset
class TCPCheck
{
public:
TCPCheck() noexcept;
~TCPCheck() noexcept;
/*! Проверка связи с сервисом на определённом порту
* \param _ip - ip проверяемого узла
......@@ -53,8 +51,6 @@ namespace uniset
* \todo Возможно стоит написать свою реализацию ping
*/
static bool ping( const std::string& _ip, timeout_t tout = 1000, const std::string& ping_argc = "-c 1 -w 0.1 -q -n" ) noexcept;
protected:
};
// -------------------------------------------------------------------------
} // end of uniset namespace
......
......@@ -27,15 +27,6 @@ using namespace std;
namespace uniset
{
// -----------------------------------------------------------------------------
TCPCheck::TCPCheck() noexcept
{
}
// -----------------------------------------------------------------------------
TCPCheck::~TCPCheck() noexcept
{
}
// -----------------------------------------------------------------------------
bool TCPCheck::check( const std::string& _iaddr, timeout_t tout ) noexcept
{
auto v = uniset::explode_str(_iaddr, ':');
......
......@@ -14,10 +14,6 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// -----------------------------------------------------------------------------------------
/*!
\todo Добавить проверку на предельный номер id
*/
// -----------------------------------------------------------------------------------------
#include <sstream>
#include <fstream>
#include <unistd.h>
......@@ -29,11 +25,6 @@
using namespace uniset;
using namespace std;
// -----------------------------------------------------------------------------------------
IORFile::IORFile()
{
}
// -----------------------------------------------------------------------------------------
string IORFile::getIOR( const ObjectId id )
{
string fname( getFileName(id) );
......
......@@ -75,9 +75,8 @@ void SMonitor::sysCommand( const SystemMessage* sm )
}
catch(...)
{
cerr << myname << ": НЕ СМОГ ЗАКАЗТЬ датчики " << endl;
// raise(SIGTERM);
//std::terminate();
std::exception_ptr p = std::current_exception();
cerr << myname << ": " << (p ? p.__cxa_exception_type()->name() : "FAIL ask sensors..") << std::endl;
uterminate();
}
}
......@@ -142,8 +141,3 @@ void SMonitor::sensorInfo( const SensorMessage* si )
}
}
// ------------------------------------------------------------------------------------------
void SMonitor::timerInfo( const uniset::TimerMessage* tm )
{
}
// ------------------------------------------------------------------------------------------
......@@ -45,12 +45,12 @@ SViewer::~SViewer()
{
}
// --------------------------------------------------------------------------
void SViewer::monitor( timeout_t timeMS )
void SViewer::monitor( timeout_t msec )
{
for(;;)
{
view();
msleep(timeMS);
msleep(msec);
}
}
......@@ -90,7 +90,8 @@ void SViewer::readSection( const string& section, const string& secRoot )
catch( ORepFailed ) {}
catch(...)
{
cout << "(readSection): get sectionlist ... catch..." << endl;
std::exception_ptr p = std::current_exception();
cout << "(readSection): get section list: " << (p ? p.__cxa_exception_type()->name() : "catch..") << std::endl;
}
if( !lst.empty() )
......@@ -118,7 +119,8 @@ void SViewer::readSection( const string& section, const string& secRoot )
}
catch(...)
{
cout << "(readSection): catch..." << endl;
std::exception_ptr p = std::current_exception();
cout << "(readSection): " << (p ? p.__cxa_exception_type()->name() : "catch..") << std::endl;
return;
}
......@@ -193,7 +195,8 @@ void SViewer::getInfo( ObjectId id )
}
catch(...)
{
cout << "(getInfo): catch ..." << endl;
std::exception_ptr p = std::current_exception();
cout << "(getInfo): " << (p ? p.__cxa_exception_type()->name() : "catch..") << std::endl;
}
}
......
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