kernel.views.variables.VariableProvider< T extends Variable > Interface Template Reference

Inheritance diagram for kernel.views.variables.VariableProvider< T extends Variable >:

Public Member Functions
List< T >	getValues ()
Duration	getLengthOfHistory ()
Integer	getNumberOfDataPoints ()
Boolean	isProvidingVariables ()
void	setNumberOfDataPoints (Integer numberOfDataPoints)
void	clearHistory ()
Duration	getPollingInterval ()
void	setPollingInterval (Duration pollingInterval) throws NegativeDurationException
void	addOnChangeListener (VariableChangeEventListener< T > listener)
void	removeOnChangeListener (VariableChangeEventListener< T > listener)

Detailed Description

Provides a measured variable of a type T as a function of time. A data series is built up by polling.

Definition at line 12 of file VariableProvider.java.

Member Function Documentation

void kernel.views.variables.VariableProvider< T extends Variable >.addOnChangeListener

(

VariableChangeEventListener< T >

listener

)

Parameters

listener

The listener to add

void kernel.views.variables.VariableProvider< T extends Variable >.clearHistory

(

)

Remove all data points from the provider

Implemented in kernel.models.variables.PressureProvider.

Duration kernel.views.variables.VariableProvider< T extends Variable >.getLengthOfHistory

(

)

Returns

The amount of time for which this variable provider can record variables

Implemented in kernel.models.variables.PressureProvider.

Integer kernel.views.variables.VariableProvider< T extends Variable >.getNumberOfDataPoints

(

)

Returns

The number of data points in this provider

Implemented in kernel.models.variables.PressureProvider.

Duration kernel.views.variables.VariableProvider< T extends Variable >.getPollingInterval

(

)

Returns

The length of the interval between polling for the variable

Implemented in kernel.models.variables.PressureProvider.

List<T> kernel.views.variables.VariableProvider< T extends Variable >.getValues

(

)

Returns

The history of values recorded by this provider

Implemented in kernel.models.variables.PressureProvider.

Boolean kernel.views.variables.VariableProvider< T extends Variable >.isProvidingVariables

(

)

Returns

Boolean#TRUE if the provider is alive, otherwise Boolean#FALSE

Implemented in kernel.models.variables.PressureProvider.

void kernel.views.variables.VariableProvider< T extends Variable >.removeOnChangeListener

(

VariableChangeEventListener< T >

listener

)

Parameters

listener

The listener to remove

void kernel.views.variables.VariableProvider< T extends Variable >.setNumberOfDataPoints

(

Integer

numberOfDataPoints

)

Parameters

numberOfDataPoints

The number of data points that the provider will store

Implemented in kernel.models.variables.PressureProvider.

void kernel.views.variables.VariableProvider< T extends Variable >.setPollingInterval

(

Duration

pollingInterval

)

throws NegativeDurationException

Parameters

pollingInterval

The desired polling interval

Exceptions

NegativeDurationException

If the duration is negative

Implemented in kernel.models.variables.PressureProvider.

---

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

• VariableProvider.java