EventEvaluator.Resource
Class ParameterValue

java.lang.Object
  |
  +--EventEvaluator.Resource.ParameterValue

public class ParameterValue
extends java.lang.Object

Current value of a parameter beeing monitored on an entity.


Constructor Summary
ParameterValue(java.lang.String pid, int initial_range)
          Receives the initial value for the parameter beeing monitored on an entity.
 
Method Summary
 java.lang.String get_pid()
          Returns the parameter identification
 int get_range()
          Returns the current value of the parameter
 boolean is_suspended()
          Check if the monitoring of the paramter is suspended
 void resume()
          Inform that the monitoring process of this parameter was resumed.
 void set_range(int new_range)
          Updates the current value of the parameter
 void suspend()
          Inform that the monitoring process of this parameter is suspended.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterValue

public ParameterValue(java.lang.String pid,
                      int initial_range)
Receives the initial value for the parameter beeing monitored on an entity.
Parameters:
pid - parameter identification
initial_range - the initial range of this parameter
Method Detail

set_range

public void set_range(int new_range)
Updates the current value of the parameter
Parameters:
new_range - the new value of the parameter

get_range

public int get_range()
Returns the current value of the parameter
Returns:
the current value of the parameter

get_pid

public java.lang.String get_pid()
Returns the parameter identification
Returns:
parameter identification

is_suspended

public boolean is_suspended()
Check if the monitoring of the paramter is suspended
Returns:
TRUE if the monitoring processes of the parameter is suspended, FALSE otherwise

suspend

public void suspend()
Inform that the monitoring process of this parameter is suspended. This method is callend whent the RMO responsible for monitoring this parameter on the entity has called the method rmo_suspend informing that it monitoring process is suspended. In this case, the current value the parameter is no longer valid and should not be used.

resume

public void resume()
Inform that the monitoring process of this parameter was resumed. This method is callend whent the RMO responsible for monitoring this parameter on the entity has called the method rmo_resume informing that it monitoring process was resumed.