gatb.core-API-1.4.2
ISystemInfo Class Referenceabstract

Interface providing some general information about the system. More...

#include <ISystemInfo.hpp>

Inheritance diagram for ISystemInfo:
Inheritance graph

Classes

class  CpuInfo
 Interface providing a way to get CPU usage information. More...
 

Public Member Functions

virtual std::string getVersion () const =0
 
virtual std::string getBuildDate () const =0
 
virtual std::string getBuildCompiler () const =0
 
virtual std::string getBuildOptions () const =0
 
virtual std::string getBuildSystem () const =0
 
virtual size_t getNbCores () const =0
 
virtual std::string getHostName () const =0
 
virtual std::string getHomeDirectory () const =0
 
virtual u_int64_t getMemoryPhysicalTotal () const =0
 
virtual u_int64_t getMemoryPhysicalUsed () const =0
 
virtual u_int64_t getMemoryPhysicalFree () const =0
 
virtual u_int64_t getMemoryProject () const =0
 
virtual u_int64_t getMemoryBuffers () const =0
 
virtual u_int64_t getMemorySelfUsed () const =0
 
virtual u_int64_t getMemorySelfMaxUsed () const =0
 
virtual ~ISystemInfo ()
 
virtual CpuInfocreateCpuInfo ()=0
 

Detailed Description

Interface providing some general information about the system.

Constructor & Destructor Documentation

virtual ~ISystemInfo ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual CpuInfo* createCpuInfo ( )
pure virtual

Create a CpuInfo object

Returns
the created object.

Implemented in SystemInfoCommon.

virtual std::string getBuildCompiler ( ) const
pure virtual

Returns the compiler name

Returns
the compiler name.

Implemented in SystemInfoCommon.

virtual std::string getBuildDate ( ) const
pure virtual

Returns the date of the library generation.

Returns
the generation date.

Implemented in SystemInfoCommon.

virtual std::string getBuildOptions ( ) const
pure virtual

Returns the compilation options

Returns
the compilation options.

Implemented in SystemInfoCommon.

virtual std::string getBuildSystem ( ) const
pure virtual

Returns the operating system name used for the library generation

Returns
the os name.

Implemented in SystemInfoCommon.

virtual std::string getHomeDirectory ( ) const
pure virtual

Returns home directory.

Returns
the home directory uri.

Implemented in SystemInfoCommon.

virtual std::string getHostName ( ) const
pure virtual

Returns the host name.

Returns
the host name.

Implemented in SystemInfoWindows, SystemInfoMacos, and SystemInfoLinux.

virtual u_int64_t getMemoryBuffers ( ) const
pure virtual

Get the size (in bytes) of the buffers memory

Returns
the buffers memory size

Implemented in SystemInfoWindows, SystemInfoMacos, and SystemInfoLinux.

virtual u_int64_t getMemoryPhysicalFree ( ) const
pure virtual

Get the size (in bytes) of the free physical memory

Returns
the free physical memory size

Implemented in SystemInfoCommon.

virtual u_int64_t getMemoryPhysicalTotal ( ) const
pure virtual

Get the size (in bytes) of the physical memory

Returns
the physical memory size

Implemented in SystemInfoWindows, SystemInfoMacos, and SystemInfoLinux.

virtual u_int64_t getMemoryPhysicalUsed ( ) const
pure virtual

Get the size (in bytes) of the used physical memory

Returns
the used physical memory size

Implemented in SystemInfoWindows, SystemInfoMacos, and SystemInfoLinux.

virtual u_int64_t getMemoryProject ( ) const
pure virtual

Get a memory size (NOTE: in MBytes) for executing a program. It may be the whole physical memory, some part of it or a constant size.

Returns
the project memory size

Implemented in SystemInfoCommon.

virtual u_int64_t getMemorySelfMaxUsed ( ) const
pure virtual

Get the size (in KBytes) of the max memory used by the current process

Returns
the memory value

Implemented in SystemInfoLinux, and SystemInfoCommon.

virtual u_int64_t getMemorySelfUsed ( ) const
pure virtual

Get the size (in KBytes) of the memory used by the current process

Returns
the memory value

Implemented in SystemInfoMacos, SystemInfoLinux, and SystemInfoCommon.

virtual size_t getNbCores ( ) const
pure virtual

Returns the number of available cores.

Returns
the number of cores.

Implemented in SystemInfoWindows, SystemInfoMacos, and SystemInfoLinux.

virtual std::string getVersion ( ) const
pure virtual

Returns the version of the library.

Returns
the version.

Implemented in SystemInfoCommon.


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