doc ru

libs/main/system/pisystemmonitor.h

@@ -29,75 +29,220 @@
 #include "pithread.h"
 #include "pifile.h"
 
-class PIP_EXPORT PISystemMonitor: public PIThread
-{
+
+//! \ingroup System
+//! \~\brief
+//! \~english Process monitoring.
+//! \~russian Мониторинг процесса.
+class PIP_EXPORT PISystemMonitor: public PIThread {
 	PIOBJECT_SUBCLASS(PISystemMonitor, PIThread)
 	friend class PIIntrospectionServer;
 public:
+	//! \~english Constructs unassigned %PISystemMonitor
+	//! \~russian Создает непривязанный %PISystemMonitor
 	PISystemMonitor();
+
 	~PISystemMonitor();
 
 #pragma pack(push, 1)
+	//! \ingroup System
+	//! \~\brief
+	//! \~english Process statistics (fixed-size fields).
+	//! \~russian Статистика процесса (фиксированные поля).
 	struct PIP_EXPORT ProcessStatsFixed {
-		ProcessStatsFixed();
-		int ID;
-		int parent_ID;
-		int group_ID;
-		int session_ID;
-		int priority;
-		int threads;
-		ullong physical_memsize;
-		ullong resident_memsize;
-		ullong share_memsize;
-		ullong virtual_memsize;
-		ullong data_memsize;
-		ullong ram_total;
-		ullong ram_free;
-		ullong ram_used;
-		float cpu_load_system;
-		float cpu_load_user;
+
+		//! \~english PID
+		//! \~russian PID
+		int ID = 0;
+
+		//! \~english Parent PID
+		//! \~russian PID родителя
+		int parent_ID = 0;
+
+		//! \~english Group ID
+		//! \~russian ID группы
+		int group_ID = 0;
+
+		//! \~english Session ID
+		//! \~russian ID сессии
+		int session_ID = 0;
+
+		//! \~english Priority
+		//! \~russian Приоритет
+		int priority = 0;
+
+		//! \~english Threads count
+		//! \~russian Количество потоков
+		int threads = 0;
+
+		//! \~english Physical memory in bytes
+		//! \~russian Физическая память в байтах
+		ullong physical_memsize = 0;
+
+		//! \~english Resident memory in bytes
+		//! \~russian Резидентная память в байтах
+		ullong resident_memsize = 0;
+
+		//! \~english Share memory in bytes
+		//! \~russian Разделяемая память в байтах
+		ullong share_memsize = 0;
+
+		//! \~english Virtual memory in bytes
+		//! \~russian Виртуальная память в байтах
+		ullong virtual_memsize = 0;
+
+		//! \~english Data memory in bytes
+		//! \~russian Память данных в байтах
+		ullong data_memsize = 0;
+
+		//! \~english
+		//! \~russian
+		ullong ram_total = 0;
+
+		//! \~english
+		//! \~russian
+		ullong ram_free = 0;
+
+		//! \~english
+		//! \~russian
+		ullong ram_used = 0;
+
+		//! \~english CPU load in kernel space
+		//! \~russian Загрузка CPU в пространстве ядра
+		float cpu_load_system = 0.f;
+
+		//! \~english CPU load in user space
+		//! \~russian Загрузка CPU в пространстве пользователя
+		float cpu_load_user = 0.f;
 	};
 
+	//! \ingroup System
+	//! \~\brief
+	//! \~english Thread statistics (fixed-size fields).
+	//! \~russian Статистика потока (фиксированные поля).
 	struct PIP_EXPORT ThreadStatsFixed {
-		ThreadStatsFixed();
-		llong id;
+
+		//! \~english TID
+		//! \~russian TID
+		llong id = 0;
+
+		//! \~english Overall live time
+		//! \~russian Полное время жизни
 		PISystemTime work_time;
+
+		//! \~english Busy time in kernel space
+		//! \~russian Время работы в пространстве ядра
 		PISystemTime kernel_time;
+
+		//! \~english Busy time in user space
+		//! \~russian Время работы в пространстве пользователя
 		PISystemTime user_time;
-		float cpu_load_kernel;
-		float cpu_load_user;
+
+		//! \~english CPU load in kernel space
+		//! \~russian Загрузка CPU в пространстве ядра
+		float cpu_load_kernel = -1.f;
+
+		//! \~english CPU load in user space
+		//! \~russian Загрузка CPU в пространстве пользователя
+		float cpu_load_user = -1.f;
+
+		//! \~english Date and time of creation
+		//! \~russian Дата и время создания
 		PIDateTime created;
 	};
 #pragma pack(pop)
 
+	//! \ingroup System
+	//! \~\brief
+	//! \~english Process statistics.
+	//! \~russian Статистика процесса.
 	struct PIP_EXPORT ProcessStats: ProcessStatsFixed {
+
+		//! \~english Fill human-readable fields
+		//! \~russian Заполнить читаемые поля
 		void makeStrings();
+
+		//! \~english Execution command
+		//! \~russian Команда запуска
 		PIString exec_name;
+
+		//! \~english State
+		//! \~russian Состояние
 		PIString state;
+
+		//! \~english Human-readable physical memory
+		//! \~russian Физическая память в читаемом виде
 		PIString physical_memsize_readable;
+
+		//! \~english Human-readable resident memory
+		//! \~russian Резидентная память в читаемом виде
 		PIString resident_memsize_readable;
+
+		//! \~english Human-readable share memory
+		//! \~russian Разделяемая память в читаемом виде
 		PIString share_memsize_readable;
+
+		//! \~english Human-readable virtual memory
+		//! \~russian Виртуальная память в читаемом виде
 		PIString virtual_memsize_readable;
+
+		//! \~english Human-readable data memory
+		//! \~russian Память данных в читаемом виде
 		PIString data_memsize_readable;
 	};
 
+	//! \ingroup System
+	//! \~\brief
+	//! \~english Thread statistics.
+	//! \~russian Статистика потока.
 	struct PIP_EXPORT ThreadStats: ThreadStatsFixed {
+
+		//! \~english Name
+		//! \~russian Имя
 		PIString name;
 	};
 
 #ifndef MICRO_PIP
+
+	//! \~english Starts monitoring of process with PID "pID" and update interval "interval_ms" milliseconds
+	//! \~russian Начинает мониторинг процесса с PID "pID" и интервалом обновления "interval_ms" миллисекунд
 	bool startOnProcess(int pID, int interval_ms = 1000);
 #endif
+
+	//! \~english Starts monitoring of application process with update interval "interval_ms" milliseconds
+	//! \~russian Начинает мониторинг процесса приложения с интервалом обновления "interval_ms" миллисекунд
 	bool startOnSelf(int interval_ms = 1000);
+
+	//! \~english Stop monitoring
+	//! \~russian Останавливает мониторинг
 	void stop();
 	
+
+	//! \~english Returns monitoring process PID
+	//! \~russian Возвращает PID наблюдаемого процесса
 	int pID() const {return pID_;}
+
+	//! \~english Returns monitoring process statistics
+	//! \~russian Возвращает статистику наблюдаемого процесса
 	ProcessStats statistic() const;
+
+	//! \~english Returns monitoring process threads statistics
+	//! \~russian Возвращает статистику потоков наблюдаемого процесса
 	PIVector<ThreadStats> threadsStatistic() const;
+
 	void setStatistic(const ProcessStats & s);
 
+
+	//! \~english
+	//! \~russian
 	static ullong totalRAM();
+
+	//! \~english
+	//! \~russian
 	static ullong freeRAM();
+
+	//! \~english
+	//! \~russian
 	static ullong usedRAM();
 
 
@@ -131,6 +276,9 @@ private:
 
 };
 
+//! \relatesalso PICout
+//! \~english Output operator to \a PICout
+//! \~russian Оператор вывода в \a PICout
 inline PICout operator <<(PICout s, const PISystemMonitor::ThreadStats & v) {
 	s.setControl(0, true);
 	s << "ThreadInfo(\"" << v.name << "\", created " << v.created
@@ -142,9 +290,25 @@ inline PICout operator <<(PICout s, const PISystemMonitor::ThreadStats & v) {
 	return s;
 }
 
+
+//! \relatesalso PIByteArray
+//! \~english Store operator
+//! \~russian Оператор сохранения
 PIP_EXPORT PIByteArray & operator <<(PIByteArray & s, const PISystemMonitor::ProcessStats & v);
+
+//! \relatesalso PIByteArray
+//! \~english Restore operator
+//! \~russian Оператор извлечения
 PIP_EXPORT PIByteArray & operator >>(PIByteArray & s,       PISystemMonitor::ProcessStats & v);
+
+//! \relatesalso PIByteArray
+//! \~english Store operator
+//! \~russian Оператор сохранения
 PIP_EXPORT PIByteArray & operator <<(PIByteArray & s, const PISystemMonitor::ThreadStats & v);
+
+//! \relatesalso PIByteArray
+//! \~english Restore operator
+//! \~russian Оператор извлечения
 PIP_EXPORT PIByteArray & operator >>(PIByteArray & s,       PISystemMonitor::ThreadStats & v);
 
 #endif // PISYSTEMMONITOR_H