SystemStats Class Reference

Contains methods for finding out about the current hardware and OS configuration. More...

List of all members.

Public Types

enum  OperatingSystemType {
  UnknownOS = 0, MacOSX = 0x1000, Linux = 0x2000, Win95 = 0x4001,
  Win98 = 0x4002, WinNT351 = 0x4103, WinNT40 = 0x4104, Win2000 = 0x4105,
  WinXP = 0x4106, WinVista = 0x4107, Windows7 = 0x4108, Windows = 0x4000,
  WindowsNT = 0x0100
}
 

The set of possible results of the getOperatingSystemType() method.

More...

Static Public Member Functions

static const String getJUCEVersion () throw ()
 Returns the current version of JUCE,.
static OperatingSystemType getOperatingSystemType () throw ()
 Returns the type of operating system we're running on.
static const String getOperatingSystemName () throw ()
 Returns the name of the type of operating system we're running on.
static bool isOperatingSystem64Bit () throw ()
 Returns true if the OS is 64-bit, or false for a 32-bit OS.
static const String getLogonName ()
 Returns the current user's name, if available.
static const String getFullUserName ()
 Returns the current user's full name, if available.
static int getCpuSpeedInMegaherz () throw ()
 Returns the approximate CPU speed.
static const String getCpuVendor () throw ()
 Returns a string to indicate the CPU vendor.
static bool hasMMX () throw ()
 Checks whether Intel MMX instructions are available.
static bool hasSSE () throw ()
 Checks whether Intel SSE instructions are available.
static bool hasSSE2 () throw ()
 Checks whether Intel SSE2 instructions are available.
static bool has3DNow () throw ()
 Checks whether AMD 3DNOW instructions are available.
static int getNumCpus () throw ()
 Returns the number of CPUs.
static int64 getClockCycleCounter () throw ()
 Returns a clock-cycle tick counter, if available.
static int getMemorySizeInMegabytes () throw ()
 Finds out how much RAM is in the machine.
static int getPageSize () throw ()
 Returns the system page-size.
static int getMACAddresses (int64 *addresses, int maxNum, bool littleEndian=true)
 Returns a list of MAC addresses found on this machine.
static const StringArray getMACAddressStrings ()
 Returns a list of MAC addresses found on this machine.
static void initialiseStats () throw ()

Detailed Description

Contains methods for finding out about the current hardware and OS configuration.


Member Enumeration Documentation

The set of possible results of the getOperatingSystemType() method.

Enumerator:
UnknownOS 
MacOSX 
Linux 
Win95 
Win98 
WinNT351 
WinNT40 
Win2000 
WinXP 
WinVista 
Windows7 
Windows 

To test whether any version of Windows is running, you can use the expression ((getOperatingSystemType() & Windows) != 0).

WindowsNT 

To test whether the platform is Windows NT or later (i.e.

not Win95 or 98), you can use the expression ((getOperatingSystemType() & WindowsNT) != 0).


Member Function Documentation

static const String SystemStats::getJUCEVersion (  )  throw () [static]

Returns the current version of JUCE,.

(just in case you didn't already know at compile-time.)

See also the JUCE_VERSION, JUCE_MAJOR_VERSION and JUCE_MINOR_VERSION macros.

static OperatingSystemType SystemStats::getOperatingSystemType (  )  throw () [static]

Returns the type of operating system we're running on.

Returns:
one of the values from the OperatingSystemType enum.
See also:
getOperatingSystemName
static const String SystemStats::getOperatingSystemName (  )  throw () [static]

Returns the name of the type of operating system we're running on.

Returns:
a string describing the OS type.
See also:
getOperatingSystemType
static bool SystemStats::isOperatingSystem64Bit (  )  throw () [static]

Returns true if the OS is 64-bit, or false for a 32-bit OS.

static const String SystemStats::getLogonName (  )  [static]

Returns the current user's name, if available.

See also:
getFullUserName()
static const String SystemStats::getFullUserName (  )  [static]

Returns the current user's full name, if available.

On some OSes, this may just return the same value as getLogonName().

See also:
getLogonName()
static int SystemStats::getCpuSpeedInMegaherz (  )  throw () [static]

Returns the approximate CPU speed.

Returns:
the speed in megahertz, e.g. 1500, 2500, 32000 (depending on what year you're reading this...)
static const String SystemStats::getCpuVendor (  )  throw () [static]

Returns a string to indicate the CPU vendor.

Might not be known on some systems.

static bool SystemStats::hasMMX (  )  throw () [static]

Checks whether Intel MMX instructions are available.

static bool SystemStats::hasSSE (  )  throw () [static]

Checks whether Intel SSE instructions are available.

static bool SystemStats::hasSSE2 (  )  throw () [static]

Checks whether Intel SSE2 instructions are available.

static bool SystemStats::has3DNow (  )  throw () [static]

Checks whether AMD 3DNOW instructions are available.

static int SystemStats::getNumCpus (  )  throw () [static]

Returns the number of CPUs.

static int64 SystemStats::getClockCycleCounter (  )  throw () [static]

Returns a clock-cycle tick counter, if available.

If the machine can do it, this will return a tick-count where each tick is one cpu clock cycle - used for profiling code.

Returns:
the tick count, or zero if not available.
static int SystemStats::getMemorySizeInMegabytes (  )  throw () [static]

Finds out how much RAM is in the machine.

Returns:
the approximate number of megabytes of memory, or zero if something goes wrong when finding out.
static int SystemStats::getPageSize (  )  throw () [static]

Returns the system page-size.

This is only used by programmers with beards.

static int SystemStats::getMACAddresses ( int64 addresses,
int  maxNum,
bool  littleEndian = true 
) [static]

Returns a list of MAC addresses found on this machine.

Parameters:
addresses an array into which the MAC addresses should be copied
maxNum the number of elements in this array
littleEndian the endianness of the numbers to return. If this is true, the least-significant byte of each number is the first byte of the mac address. If false, the least significant byte is the last number. Note that the default values of this parameter are different on Mac/PC to avoid breaking old software that was written before this parameter was added (when the two systems defaulted to using different endiannesses). In newer software you probably want to specify an explicit value for this.
Returns:
the number of MAC addresses that were found
static const StringArray SystemStats::getMACAddressStrings (  )  [static]

Returns a list of MAC addresses found on this machine.

Returns:
an array of strings containing the MAC addresses that were found
static void SystemStats::initialiseStats (  )  throw () [static]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Apr 26 11:42:18 2010 for JUCE by  doxygen 1.6.3