NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Functions
BiometricEvaluation::System Namespace Reference

Operating system, hardware, etc. More...

Functions

uint32_t getCPUCount ()
 Obtain the number of central processing units that are online. More...
 
uint32_t getCPUCoreCount ()
 Obtain the number of CPU cores that are online. More...
 
uint32_t getCPUSocketCount ()
 Obtain the number of CPU sockets that are online. More...
 
uint64_t getRealMemorySize ()
 Obtain the amount of real memory in the system. More...
 
double getLoadAverage ()
 Obtain the system load average for the last minute. More...
 

Detailed Description

Operating system, hardware, etc.

The System package gathers all system related matters, such as the operating system name, number of CPUs, etc.

Function Documentation

◆ getCPUCount()

uint32_t BiometricEvaluation::System::getCPUCount ( )

Obtain the number of central processing units that are online.

Typically, this is the total logical CPU count for the system, often called hyperthreads.

Returns
The number of processing units.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.

◆ getCPUCoreCount()

uint32_t BiometricEvaluation::System::getCPUCoreCount ( )

Obtain the number of CPU cores that are online.

Obtain the number of central processing units that are online.

Returns
The number of CPU cores.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.

This is the total CPU core count for the system.

Returns
The number of CPU cores.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.

◆ getCPUSocketCount()

uint32_t BiometricEvaluation::System::getCPUSocketCount ( )

Obtain the number of CPU sockets that are online.

The hierarchy is CPU (thread) -> Core -> Socket, where there are 1..n hyperthreads per core and 1..n cores per socket.

Returns
The number of CPU sockets.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.

◆ getRealMemorySize()

uint64_t BiometricEvaluation::System::getRealMemorySize ( )

Obtain the amount of real memory in the system.

Returns
The real memory size, in kibibytes.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.

◆ getLoadAverage()

double BiometricEvaluation::System::getLoadAverage ( )

Obtain the system load average for the last minute.

Returns
The system load average.
Exceptions
Error::NotImplementedNot implemented for this operating system, or the underlying OS feature is not installed.