ML Reference
ml::MemoryInfo Class Reference

#include <mlMemoryInfo.h>

Public Member Functions

unsigned int getTotalPhysicalMemoryInMB () const
 Returns the total amount of physical memory in MB.
unsigned int getAvailableMemoryInMB () const
 Returns the available amount of memory in MB.

Static Public Member Functions

static MemoryInfo & getInstance ()

Protected Member Functions

 MemoryInfo ()

Detailed Description

Singleton class that provides hardware specific information. To get a pointer to a valid object of this type, use the getInstance() method.

Definition at line 26 of file mlMemoryInfo.h.

Constructor & Destructor Documentation

◆ MemoryInfo()

ml::MemoryInfo::MemoryInfo ( )
protected

This constructor must not be called from anywhere else but the getInstance() method, which does call this function if the static pointer to the valid object is not set yet.

Referenced by getInstance().

Member Function Documentation

◆ getAvailableMemoryInMB()

unsigned int ml::MemoryInfo::getAvailableMemoryInMB ( ) const
inline

Returns the available amount of memory in MB.

Definition at line 56 of file mlMemoryInfo.h.

◆ getInstance()

MemoryInfo & ml::MemoryInfo::getInstance ( )
static

Returns the single existing object of this class. The concept of this class is based on the Singleton design pattern that ensures there is only one object of this class. (NOT THREAD-SAFE!)

References MemoryInfo().

◆ getTotalPhysicalMemoryInMB()

unsigned int ml::MemoryInfo::getTotalPhysicalMemoryInMB ( ) const
inline

Returns the total amount of physical memory in MB.

Definition at line 48 of file mlMemoryInfo.h.

The documentation for this class was generated from the following file: