GridLab
Grid Application Toolkit

A simple API for Grid Applications 		GAT
Menu


Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

monitoring::MetricEvent Class Reference

An instance of this class represents an metric event. More...

Inheritance diagram for monitoring::MetricEvent:

Inheritance graph
[legend]
Collaboration diagram for monitoring::MetricEvent:

Collaboration graph
[legend]
List of all members.

Public Methods

 MetricEvent (Object source, Object value, Metric metric, long eventTime)
 Constructs a MetricEvent with the specified properties.

Metric getMetric ()
 This method returns an instance of the Metric to which this MetricEvent corresponds.

Object getValue ()
 This method returns the value corresponding to this MetricEvent.

long getEventTime ()
 This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the event happened.


Private Attributes

long eventTime = 0
 This member variable holds the event time of this MetricEvent.

Object value = null
 This member variable holds the value of this MetricEvent.

Metric metric = null
 This member variable holds the metric of this MetricEvent.

Detailed Description

An instance of this class represents an metric event.

A metric event occurs whenever the monitored resource, be it a job or a hardware resource, sends out an event to the monitoring system. This can encompass almost any type of event from disk space running out to memory becoming available. The various events are defined by the various sensors. This topic is covered in more detail in the Metric documentation.

Definition at line 14 of file MetricEvent.java.

Constructor & Destructor Documentation

monitoring::MetricEvent::MetricEvent (  Object    source,
Object    value,
Metric    metric,
long    eventTime
)  [inline]
 

Constructs a MetricEvent with the specified properties.

Parameters:
source  The source of the MetricEvent
value  The value of the MetricEvent
metric  The Metric of the MetricEvent
eventTime  The number of milliseconds after January 1, 1970, 00:00:00 GMT when the MetricEvent happened.

Definition at line 39 of file MetricEvent.java.

References monitoring::MetricEvent::eventTime, and monitoring::MetricEvent::value.

Member Function Documentation

Metric monitoring::MetricEvent::getMetric (    )  [inline]
 

This method returns an instance of the Metric to which this MetricEvent corresponds.

Returns:
A Metric corresponding to this MetricEvent

Definition at line 53 of file MetricEvent.java.

Object monitoring::MetricEvent::getValue (    )  [inline]
 

This method returns the value corresponding to this MetricEvent.

Returns:
An Object which is the value of this MetricEvent.

Definition at line 62 of file MetricEvent.java.

References monitoring::MetricEvent::value.

long monitoring::MetricEvent::getEventTime (    )  [inline]
 

This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the event happened.

Returns:
A long, the number of milliseconds after January 1, 1970, 00:00:00 GMT when the event happened.

Definition at line 73 of file MetricEvent.java.

References monitoring::MetricEvent::eventTime.

Member Data Documentation

long monitoring::MetricEvent::eventTime = 0 [private]
 

This member variable holds the event time of this MetricEvent.

Definition at line 18 of file MetricEvent.java.

Referenced by monitoring::MetricEvent::getEventTime(), and monitoring::MetricEvent::MetricEvent().

Object monitoring::MetricEvent::value = null [private]
 

This member variable holds the value of this MetricEvent.

Definition at line 23 of file MetricEvent.java.

Referenced by monitoring::MetricEvent::getValue(), and monitoring::MetricEvent::MetricEvent().

Metric monitoring::MetricEvent::metric = null [private]
 

This member variable holds the metric of this MetricEvent.

Definition at line 28 of file MetricEvent.java.

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