Inheritance diagram for kernel.models.variables.PressureProvider:

Collaboration diagram for kernel.models.variables.PressureProvider:

Public Member Functions
	PressureProvider (PressureGauge gauge, Kernel kernel)

List< Pressure >	getValues ()

Boolean	isProvidingVariables ()

void	clearHistory ()

Integer	getNumberOfDataPoints ()

void	setNumberOfDataPoints (Integer numberOfDataPoints)

Duration	getLengthOfHistory ()

Duration	getPollingInterval ()

void	setPollingInterval (Duration pollingInterval) throws NegativeDurationException

void	addOnChangeListener (VariableChangeEventListener< Pressure > listener)

void	removeOnChangeListener (VariableChangeEventListener< Pressure > listener)

Public Member Functions inherited from kernel.views.variables.VariableProvider< T extends Variable >
void	addOnChangeListener (VariableChangeEventListener< T > listener)

void	removeOnChangeListener (VariableChangeEventListener< T > listener)

Detailed Description

Provides the pressure measured by the PVCi Pressure gauge. Responsible for polling the PVCi pressure gauge and retrieving the pressure.

Definition at line 21 of file models/variables/PressureProvider.java.

Constructor & Destructor Documentation

kernel.models.variables.PressureProvider.PressureProvider	(	PressureGauge	gauge,
		Kernel	kernel
	)

Parameters

gauge	The pressure gauge to use for making measurements
kernel	The kernel to use

Definition at line 61 of file models/variables/PressureProvider.java.

                                                                {
         this.pressureGauge = gauge;
         Runnable pressureTask = new PressurePollingTask();
         isPollingThreadAlive = Boolean.TRUE;
         kernel.getTaskRunner().execute(pressureTask);
     }

Member Function Documentation

void kernel.models.variables.PressureProvider.addOnChangeListener ( VariableChangeEventListener< Pressure > listener )

Add a listener to the list of listeners. This provider will then notify the listeners that the variable changed.

Parameters

listener The listener to add

Definition at line 149 of file models/variables/PressureProvider.java.

                                                            {
         listeners.add(listener);
     }

void kernel.models.variables.PressureProvider.clearHistory ( )

Remove all entries in this variable provider

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 88 of file models/variables/PressureProvider.java.

                               {
         pressures.clear();
     }

Duration kernel.models.variables.PressureProvider.getLengthOfHistory ( )

Returns: The length of time for which this provider is recording the variable history

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 117 of file models/variables/PressureProvider.java.

                                         {
         return pollingInterval.multipliedBy(numberOfDataPoints);
     }

Integer kernel.models.variables.PressureProvider.getNumberOfDataPoints ( )

Returns: The number of data points in this provider's history

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 96 of file models/variables/PressureProvider.java.

                                           {
         return this.numberOfDataPoints;
     }

Duration kernel.models.variables.PressureProvider.getPollingInterval ( )

Returns: The time between which the program is asking for the pressure

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 125 of file models/variables/PressureProvider.java.

                                         {
         return pollingInterval;
     }

List<Pressure> kernel.models.variables.PressureProvider.getValues ( )

Returns: The list of values recorded by this variable provider

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 72 of file models/variables/PressureProvider.java.

                                      {
         return pressures;
     }

Boolean kernel.models.variables.PressureProvider.isProvidingVariables ( )

Returns: Boolean#TRUE if it is and Boolean#FALSE if not

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 80 of file models/variables/PressureProvider.java.

                                          {
         return isPollingThreadAlive;
     }

void kernel.models.variables.PressureProvider.removeOnChangeListener ( VariableChangeEventListener< Pressure > listener )

Parameters

listener The listener to remove from the list

Definition at line 158 of file models/variables/PressureProvider.java.

                                                            {
         listeners.remove(listener);
     }

void kernel.models.variables.PressureProvider.setNumberOfDataPoints ( Integer numberOfDataPoints )

Parameters

numberOfDataPoints The number of data points that need to be recorded. When a new data point is recorded, a check is made to see if the number of data points exceeds this maximum. If it does, the oldest entry is removed from the list

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 108 of file models/variables/PressureProvider.java.

                                                                   {
         this.numberOfDataPoints = numberOfDataPoints;
     }

void kernel.models.variables.PressureProvider.setPollingInterval ( Duration pollingInterval ) throws NegativeDurationException

Parameters

pollingInterval The desired polling interval

Exceptions

NegativeDurationException if the interval is attempted to be set to a negative value.

Implements kernel.views.variables.VariableProvider< T extends Variable >.

Definition at line 135 of file models/variables/PressureProvider.java.

                                       {
         if (pollingInterval.isNegative()){
             throw new NegativeDurationException(pollingInterval);
         }
         this.pollingInterval = pollingInterval;
     }

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

models/variables/PressureProvider.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation