com.ace.moab.api.credential
Class ResourceUsage

java.lang.Object
  com.ace.moab.api.credential.ResourceUsage

public class ResourceUsage
extends java.lang.Object

The resource usage of any given credential. The values contained in this class represent the total amount of resources the credentials have used so far. Moab stores this information and can report it back when requested.

Author:

Scott Brown

Constructor Summary

ResourceUsage()
Default constructor.

Method Summary

int	getHardLimitActiveJobs() Get the hard limit of Active jobs this credential may have.
int	getHardLimitActiveNodes() Get the hard limit of Active nodes this credential may access.
int	getHardLimitActiveProcs() Get the hard limit of Active processors this credential may access.
long	getHardLimitActiveProcSec() Get the hard limit of Active processor seconds this credential may utilize.
int	getHardLimitIdleJobs() Get the hard limit of idle jobs this credential may have.
long	getSoftLimitAcitveProcSec() Get the soft limit of Active processor seconds this credential may utilize.
int	getSoftLimitActiveJobs() Get the soft limit of Active jobs this credential may have.
int	getSoftLimitActiveNodes() Get the soft limit of Active nodes this credential may access.
int	getSoftLimitActiveProcs() Get the soft limit of Active processors this credential may access.
long	getSoftLimitActiveProcSec() Get the soft limit of Active processor seconds this credential may utilize.
int	getSoftLimitIdleJobs() Get the soft limit of idle jobs this credential may have.
int	getUtilizedJobs() Get the current number of jobs this credential is currently using.
long	getUtilizedMem() Get the current amount of utilized memory this credential is currently using.
int	getUtilizedNodes() Get the current number of nodes this credential is currently using.
int	getUtilizedProc() Get the current number of processors this credential is currently using.
long	getUtilizedProcSec() Get the current number of processor seconds this credential is currently using.
void	setDefaultValues(ResourceUsage other) Sets Default Values for Resource Usage.
void	setHardLimitActiveJobs(int hardLimitActiveJobs) Set the hard limit of active jobs that this credential can use.
void	setHardLimitActiveNodes(int hardLimitActiveNodes) Set the hard limit of active nodes that this credential can use.
void	setHardLimitActiveProcs(int hardLimitActiveProcss) Set the hard limit of active processors that this credential can use.
void	setHardLimitActiveProcSec(long hardLimitActiveProcSec) Set the hard limit of active processor seconds that this credential can use.
void	setHardLimitIdleJobs(int hardLimitIdleJobs) Set the hard limit of idle jobs that this credential can use.
void	setSoftLimitAcitveProcSec(int softLimitAcitveProcSec) Set the soft limit of active processor seconds that this credential can use.
void	setSoftLimitActiveJobs(int softLimitActiveJobs) Set the soft limit of active jobs that this credential can use.
void	setSoftLimitActiveNodes(int softLimitActiveNodes) Set the soft limit of active nodes that this credential can use.
void	setSoftLimitActiveProcs(int softLimitActiveProcs) Set the soft limit of active processors that this credential can use.
void	setSoftLimitActiveProcSec(long softLimitActiveProcSec) Set the soft limit of active processor seconds that this credential can use.
void	setSoftLimitIdleJobs(int softLimitIdleJobs) Set the soft limit of idle jobs that this credential can use
void	setUtilizedJobs(int utilizedJobs) Set the number of jobs this credential is currently using.
void	setUtilizedMem(long utilizedMem) Set the amount of memory (in MB) this credential is currently using.
void	setUtilizedNodes(int utilizedNodes) Set the number of nodes this credential is currently using.
void	setUtilizedProc(int utilizedProc) Set the number of processors this credential is currently using
void	setUtilizedProcSec(long utilizedProcSec) Set the number of processor seconds this credential is currently using.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUsage

public ResourceUsage()

Default constructor. All usage attributes are empty, or 0

Method Detail

getHardLimitActiveJobs

public int getHardLimitActiveJobs()

Get the hard limit of Active jobs this credential may have.

Returns:

the hardLimitActiveJobs

getHardLimitActiveNodes

public int getHardLimitActiveNodes()

Get the hard limit of Active nodes this credential may access.

Returns:

the hardLimitActiveNodes

getHardLimitActiveProcs

public int getHardLimitActiveProcs()

Get the hard limit of Active processors this credential may access.

Returns:

the hardLimitActiveProcss

getHardLimitActiveProcSec

public long getHardLimitActiveProcSec()

Get the hard limit of Active processor seconds this credential may utilize.

Returns:

the hardLimitActiveProcSec

getHardLimitIdleJobs

public int getHardLimitIdleJobs()

Get the hard limit of idle jobs this credential may have.

Returns:

the hardLimitIdleJobs

getSoftLimitAcitveProcSec

public long getSoftLimitAcitveProcSec()

Get the soft limit of Active processor seconds this credential may utilize.

Returns:

the softLimitAcitveProcSec

getSoftLimitActiveJobs

public int getSoftLimitActiveJobs()

Get the soft limit of Active jobs this credential may have.

Returns:

the softLimitActiveJobs

getSoftLimitActiveNodes

public int getSoftLimitActiveNodes()

Get the soft limit of Active nodes this credential may access.

Returns:

the softLimitActiveNodes

getSoftLimitActiveProcs

public int getSoftLimitActiveProcs()

Get the soft limit of Active processors this credential may access.

Returns:

the softLimitActiveProcs

getSoftLimitActiveProcSec

public long getSoftLimitActiveProcSec()

Get the soft limit of Active processor seconds this credential may utilize.

Returns:

the softLimitActiveProcSec

getSoftLimitIdleJobs

public int getSoftLimitIdleJobs()

Get the soft limit of idle jobs this credential may have.

Returns:

the softLimitIdleJobs

getUtilizedJobs

public int getUtilizedJobs()

Get the current number of jobs this credential is currently using.

Returns:

the utilizedJobs

getUtilizedMem

public long getUtilizedMem()

Get the current amount of utilized memory this credential is currently using.

Returns:

the utilizedMem

getUtilizedNodes

public int getUtilizedNodes()

Get the current number of nodes this credential is currently using.

Returns:

the utilizedNodes

getUtilizedProc

public int getUtilizedProc()

Get the current number of processors this credential is currently using.

Returns:

the utilizedProc

getUtilizedProcSec

public long getUtilizedProcSec()

Get the current number of processor seconds this credential is currently using.

Returns:

the utilizedProcSec

setDefaultValues

public void setDefaultValues(ResourceUsage other)

Sets Default Values for Resource Usage. For every object not explicitly set, this method sets the attributes to equal that of the other ResourceUsage object. This is useful in Moab where a user can specify default values but can explicitly set other attributes that override the defaults. This method checks each limit attribute to see if it has already been set, and if not sets the attribute to equal that of the other ResourceUsage object.

Parameters:

other - The object that contains all resource information that will be used in the defaults of the original object

setHardLimitActiveJobs

public void setHardLimitActiveJobs(int hardLimitActiveJobs)

Set the hard limit of active jobs that this credential can use.

Parameters:

hardLimitActiveJobs - the hard limit of active jobs that this credential can use

setHardLimitActiveNodes

public void setHardLimitActiveNodes(int hardLimitActiveNodes)

Set the hard limit of active nodes that this credential can use.

Parameters:

hardLimitActiveNodes - the hard limit of active nodes that this credential can use

setHardLimitActiveProcs

public void setHardLimitActiveProcs(int hardLimitActiveProcss)

Set the hard limit of active processors that this credential can use.

Parameters:

hardLimitActiveProcss - the hard limit of active processors that this credential can use

setHardLimitActiveProcSec

public void setHardLimitActiveProcSec(long hardLimitActiveProcSec)

Set the hard limit of active processor seconds that this credential can use.

Parameters:

hardLimitActiveProcSec - the hard limit of active processor seconds that this credential can use

setHardLimitIdleJobs

public void setHardLimitIdleJobs(int hardLimitIdleJobs)

Set the hard limit of idle jobs that this credential can use.

Parameters:

hardLimitIdleJobs - the hard limit of idle jobs that this credential can use

setSoftLimitAcitveProcSec

public void setSoftLimitAcitveProcSec(int softLimitAcitveProcSec)

Set the soft limit of active processor seconds that this credential can use.

Parameters:

softLimitAcitveProcSec - the soft limit of active processor seconds that this credential can use

setSoftLimitActiveJobs

public void setSoftLimitActiveJobs(int softLimitActiveJobs)

Set the soft limit of active jobs that this credential can use.

Parameters:

softLimitActiveJobs - the soft limit of active jobs that this credential can use

setSoftLimitActiveNodes

public void setSoftLimitActiveNodes(int softLimitActiveNodes)

Set the soft limit of active nodes that this credential can use.

Parameters:

softLimitActiveNodes - the soft limit of active nodes that this credential can use

setSoftLimitActiveProcs

public void setSoftLimitActiveProcs(int softLimitActiveProcs)

Set the soft limit of active processors that this credential can use.

Parameters:

softLimitActiveProcs - the soft limit of active processors that this credential can use

setSoftLimitActiveProcSec

public void setSoftLimitActiveProcSec(long softLimitActiveProcSec)

Set the soft limit of active processor seconds that this credential can use.

Parameters:

softLimitActiveProcSec - the soft limit of active processor seconds that this credential can use

setSoftLimitIdleJobs

public void setSoftLimitIdleJobs(int softLimitIdleJobs)

Set the soft limit of idle jobs that this credential can use

Parameters:

softLimitIdleJobs - the soft limit of idle jobs that this credential can use

setUtilizedJobs

public void setUtilizedJobs(int utilizedJobs)

Set the number of jobs this credential is currently using.

Parameters:

utilizedJobs - the number of jobs this credential is currently using

setUtilizedMem

public void setUtilizedMem(long utilizedMem)

Set the amount of memory (in MB) this credential is currently using.

Parameters:

utilizedMem - the amount of memory (in MB) this credential is currently using

setUtilizedNodes

public void setUtilizedNodes(int utilizedNodes)

Set the number of nodes this credential is currently using.

Parameters:

utilizedNodes - the number of nodes this credential is currently using

setUtilizedProc

public void setUtilizedProc(int utilizedProc)

Set the number of processors this credential is currently using

Parameters:

utilizedProc - the number of processors this credential is currently using

setUtilizedProcSec

public void setUtilizedProcSec(long utilizedProcSec)

Set the number of processor seconds this credential is currently using.

Parameters:

utilizedProcSec - the number of processor seconds this credential is currently using