oshi.software.os.windows.nt

Class CentralProcessor

java.lang.Object

oshi.software.os.windows.nt.CentralProcessor

All Implemented Interfaces:

Processor

public class CentralProcessor
extends Object
implements Processor

A CPU as defined in Windows registry.

Author:

dblock[at]dblock[dot]org, alessio.fachechi[at]gmail[dot]com, widdis[at]gmail[dot]com

Constructor Summary

Constructors

Constructor and Description
CentralProcessor(int procNo) Create a Processor with the given number

Method Summary

Methods

Modifier and Type	Method and Description
String	getFamily()
String	getIdentifier() Identifier, eg.
float	getLoad() Deprecated.
String	getModel()
String	getName() Name, eg.
double	getProcessorCpuLoadBetweenTicks() Returns the "recent cpu usage" for this processor by counting ticks for this processor from Processor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[]	getProcessorCpuLoadTicks() Get this Processor's CPU Load tick counters.
int	getProcessorNumber() Gets the processor number of this object, passed as an arg in the constructor.
String	getStepping()
double	getSystemCpuLoad() Returns the "recent cpu usage" for the whole system from com.sun.management.OperatingSystemMXBean#getSystemCpuLoad() if a user is running the Oracle JVM.
double	getSystemCpuLoadBetweenTicks() Returns the "recent cpu usage" for the whole system by counting ticks from Processor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[]	getSystemCpuLoadTicks() Get System-wide CPU Load tick counters.
double	getSystemLoadAverage() Returns the system load average for the last minute from OperatingSystemMXBean.getSystemLoadAverage() .
String	getVendor() Vendor identifier, eg.
long	getVendorFreq() Vendor frequency (in Hz), eg.
boolean	isCpu64bit() Is CPU 64bit?
void	setCpu64(boolean cpu64) Set flag is cpu is 64bit.
void	setFamily(String family)
void	setIdentifier(String identifier) Set processor identifier.
void	setModel(String model)
void	setName(String name) Set processor name.
void	setStepping(String stepping)
void	setVendor(String vendor) Set processor vendor.
void	setVendorFreq(long freq) Set vendor frequency.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CentralProcessor

public CentralProcessor(int procNo)

Create a Processor with the given number

Parameters:

procNo -

Method Detail

getProcessorNumber

public int getProcessorNumber()

Gets the processor number of this object, passed as an arg in the constructor.

Specified by:

getProcessorNumber in interface Processor

Returns:

The processor number

getVendor

public String getVendor()

Vendor identifier, eg. GenuineIntel.

Specified by:

getVendor in interface Processor

Returns:

Processor vendor.

setVendor

public void setVendor(String vendor)

Set processor vendor.

Specified by:

setVendor in interface Processor

Parameters:

vendor - Vendor.

getName

public String getName()

Name, eg. Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz

Specified by:

getName in interface Processor

Returns:

Processor name.

setName

public void setName(String name)

Set processor name.

Specified by:

setName in interface Processor

Parameters:

name - Name.

getVendorFreq

public long getVendorFreq()

Vendor frequency (in Hz), eg. for processor named Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz the vendor frequency is 2000000000.

Specified by:

getVendorFreq in interface Processor

Returns:

Processor frequency or -1 if unknown.

setVendorFreq

public void setVendorFreq(long freq)

Set vendor frequency.

Specified by:

setVendorFreq in interface Processor

Parameters:

freq - Frequency.

getIdentifier

public String getIdentifier()

Identifier, eg. x86 Family 6 Model 15 Stepping 10.

Specified by:

getIdentifier in interface Processor

Returns:

Processor identifier.

setIdentifier

public void setIdentifier(String identifier)

Set processor identifier.

Specified by:

setIdentifier in interface Processor

Parameters:

identifier - Identifier.

isCpu64bit

public boolean isCpu64bit()

Is CPU 64bit?

Specified by:

isCpu64bit in interface Processor

Returns:

True if cpu is 64bit.

setCpu64

public void setCpu64(boolean cpu64)

Set flag is cpu is 64bit.

Specified by:

setCpu64 in interface Processor

Parameters:

cpu64 - True if cpu is 64.

getStepping

public String getStepping()

Specified by:

getStepping in interface Processor

Returns:

the _stepping

setStepping

public void setStepping(String stepping)

Specified by:

setStepping in interface Processor

Parameters:

stepping - the _stepping to set

getModel

public String getModel()

Specified by:

getModel in interface Processor

Returns:

the _model

setModel

public void setModel(String model)

Specified by:

setModel in interface Processor

Parameters:

model - the _model to set

getFamily

public String getFamily()

Specified by:

getFamily in interface Processor

Returns:

the _family

setFamily

public void setFamily(String family)

Specified by:

setFamily in interface Processor

Parameters:

family - the _family to set

getLoad

@Deprecated
public float getLoad()

Deprecated.

Returns the "recent cpu usage" for the whole system by counting ticks from Processor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling at intervals of 1 second or longer.

Specified by:

getLoad in interface Processor

Returns:

CPU load in %

getSystemCpuLoadBetweenTicks

public double getSystemCpuLoadBetweenTicks()

Returns the "recent cpu usage" for the whole system by counting ticks from Processor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling at intervals of 1 second or longer.

Specified by:

getSystemCpuLoadBetweenTicks in interface Processor

Returns:

CPU load between 0 and 1 (100%)

getSystemCpuLoadTicks

public long[] getSystemCpuLoadTicks()

Get System-wide CPU Load tick counters. Returns an array with four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated.

Specified by:

getSystemCpuLoadTicks in interface Processor

Returns:

An array of 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

getSystemCpuLoad

public double getSystemCpuLoad()

Returns the "recent cpu usage" for the whole system from com.sun.management.OperatingSystemMXBean#getSystemCpuLoad() if a user is running the Oracle JVM. This value is a double in the [0.0,1.0] interval. A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed. All values between 0.0 and 1.0 are possible depending of the activities going on in the system. If the system recent cpu usage is not available, the method returns a negative value. Calling this method immediately upon instantiating the Processor may give unreliable results. If a user is not running the Oracle JVM, this method will default to the behavior and return value of Processor.getSystemCpuLoadBetweenTicks().

Specified by:

getSystemCpuLoad in interface Processor

Returns:

the "recent cpu usage" for the whole system; a negative value if not available.

getSystemLoadAverage

public double getSystemLoadAverage()

Returns the system load average for the last minute from OperatingSystemMXBean.getSystemLoadAverage() . The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average. If the load average is not available, a negative value is returned. This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platforms (e.g., Windows) where it is expensive to implement this method.

Specified by:

getSystemLoadAverage in interface Processor

Returns:

the system load average; or a negative value if not available.

getProcessorCpuLoadBetweenTicks

public double getProcessorCpuLoadBetweenTicks()

Returns the "recent cpu usage" for this processor by counting ticks for this processor from Processor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling (iterating over all processors) at intervals of 1 second or longer.

Specified by:

getProcessorCpuLoadBetweenTicks in interface Processor

Returns:

CPU load between 0 and 1 (100%)

getProcessorCpuLoadTicks

public long[] getProcessorCpuLoadTicks()

Get this Processor's CPU Load tick counters. Returns an array with four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated.

Specified by:

getProcessorCpuLoadTicks in interface Processor

Returns:

An array of 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

toString

public String toString()

Overrides:

toString in class Object