.TH "kysdk.Resource" 3 "Thu Sep 21 2023" "My Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
kysdk.Resource \- System resource usage information class used to obtain total physical memory size, physical memory usage rate, physical memory usage size, actually available physical memory size, actually free physical memory size, total virtual memory allocated by all applications, total Swap partition size, Swap partition usage rate, Swap partition usage, Swap partition free size, CPU instantaneous usage rate, and operating system uptime

.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBkysdk\&.Base\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBgetMemTotalKiB\fP (self)"
.br
.RI "Get the total physical memory size of the system"
.ti -1c
.RI "def \fBgetMemUsagePercent\fP (self)"
.br
.RI "Get the physical memory usage rate"
.ti -1c
.RI "def \fBgetMemUsageKiB\fP (self)"
.br
.RI "Get the physical memory usage size, note that Buffer/Cache is counted as used memory"
.ti -1c
.RI "def \fBgetMemAvailableKiB\fP (self)"
.br
.RI "Get the actually available physical memory size, this value is approximately equal to Free + Buffer + Cache"
.ti -1c
.RI "def \fBgetMemFreeKiB\fP (self)"
.br
.RI "Get the actually free physical memory size, note that Buffer/Cache is counted as used memory"
.ti -1c
.RI "def \fBgetMemVirtAllocKiB\fP (self)"
.br
.RI "Get the total virtual memory allocated by all applications"
.ti -1c
.RI "def \fBgetMemSwapTotalKiB\fP (self)"
.br
.RI "Get the total Swap partition size of the system"
.ti -1c
.RI "def \fBgetMemSwapUsagePercent\fP (self)"
.br
.RI "Get the Swap partition usage rate"
.ti -1c
.RI "def \fBgetMemSwapUsageKiB\fP (self)"
.br
.RI "Get the Swap partition usage"
.ti -1c
.RI "def \fBgetMemSwapFreeKiB\fP (self)"
.br
.RI "Get the Swap partition free size"
.ti -1c
.RI "def \fBgetCpuCurrentUsage\fP (self)"
.br
.RI "Get the CPU instantaneous usage rate"
.ti -1c
.RI "def \fBgetUpTime\fP (self)"
.br
.RI "Get the operating system uptime"
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
System resource usage information class used to obtain total physical memory size, physical memory usage rate, physical memory usage size, actually available physical memory size, actually free physical memory size, total virtual memory allocated by all applications, total Swap partition size, Swap partition usage rate, Swap partition usage, Swap partition free size, CPU instantaneous usage rate, and operating system uptime

.SH "Member Function Documentation"
.PP 
.SS "def kysdk\&.Resource\&.getCpuCurrentUsage ( self)"

.PP
Get the CPU instantaneous usage rate
.PP
\fBReturns\fP
.RS 4
CPU instantaneous usage rate, this value < 1.00
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemAvailableKiB ( self)"

.PP
Get the actually available physical memory size, this value is approximately equal to Free + Buffer + Cache
.PP
\fBReturns\fP
.RS 4
Available physical memory size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemFreeKiB ( self)"

.PP
Get the actually free physical memory size, note that Buffer/Cache is counted as used memory
.PP
\fBReturns\fP
.RS 4
Free physical memory size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemSwapFreeKiB ( self)"

.PP
Get the Swap partition free size
.PP
\fBReturns\fP
.RS 4
Swap partition free size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemSwapTotalKiB ( self)"

.PP
Get the total Swap partition size of the system
.PP
\fBReturns\fP
.RS 4
Swap partition size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemSwapUsageKiB ( self)"

.PP
Get the Swap partition usage
.PP
\fBReturns\fP
.RS 4
Swap partition usage, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemSwapUsagePercent ( self)"

.PP
Get the Swap partition usage rate
.PP
\fBReturns\fP
.RS 4
Swap partition usage rate
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemTotalKiB ( self)"

.PP
Get the total physical memory size of the system
.PP
\fBReturns\fP
.RS 4
Physical memory size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemUsageKiB ( self)"

.PP
Get the physical memory usage size, note that Buffer/Cache is counted as used memory
.PP
\fBReturns\fP
.RS 4
Physical memory usage size, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemUsagePercent ( self)"

.PP
Get the physical memory usage rate
.PP
\fBReturns\fP
.RS 4
Physical memory usage rate
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getMemVirtAllocKiB ( self)"

.PP
Get the total virtual memory allocated by all applications
.PP
\fBReturns\fP
.RS 4
Total virtual memory allocated, in KiB
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.Resource\&.getUpTime ( self)"

.PP
Get the operating system uptime
.PP
\fBReturns\fP
.RS 4
System uptime
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for kysdk.py from the source code\&.