kernel.models.variables.VoltageProvider Class Reference

Inheritance diagram for kernel.models.variables.VoltageProvider:

Collaboration diagram for kernel.models.variables.VoltageProvider:

Public Member Functions
	VoltageProvider (PowerSupply powerSupply, Kernel kernel)
List< Voltage >	getValues ()
Boolean	isProvidingVariables ()
void	clearHistory ()
Integer	getNumberOfDataPoints ()
void	setNumberOfDataPoints (Integer numberOfDataPoints)
void	setPollingInterval (Duration interval) throws NegativeDurationException
Duration	getLengthOfHistory ()
Duration	getPollingInterval ()
void	removeOnChangeListener (VariableChangeEventListener< Voltage > listener)
void	addOnChangeListener (VariableChangeEventListener< Voltage > listener)
Public Member Functions inherited from kernel.views.variables.VariableProvider< Voltage >
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

Contains an implementation of a provider to retrieve the voltage being sent to the power supply

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

Constructor & Destructor Documentation

kernel.models.variables.VoltageProvider.VoltageProvider	(	PowerSupply	powerSupply,
		Kernel	kernel
	)

Parameters

powerSupply	The power supply to use for getting the voltage
kernel	The kernel to which this provider is attached

Definition at line 62 of file models/variables/VoltageProvider.java.

                                                                  {
        this.powerSupply = powerSupply;
        isThreadAlive = Boolean.TRUE;
        kernel.getTaskRunner().execute(new VoltagePollingTask());
    }

Member Function Documentation

void kernel.models.variables.VoltageProvider.addOnChangeListener

(

VariableChangeEventListener< Voltage >

listener

)

Add a listener to be notified

Parameters

listener

The listener to add

Definition at line 154 of file models/variables/VoltageProvider.java.

     {
        listeners.add(listener);
    }

void kernel.models.variables.VoltageProvider.clearHistory

(

)

Clear the list of recorded voltages

Definition at line 89 of file models/variables/VoltageProvider.java.

                              {
        voltages.clear();
    }

Duration kernel.models.variables.VoltageProvider.getLengthOfHistory

(

)

Returns

The length of time that is recorded by this provider

Definition at line 127 of file models/variables/VoltageProvider.java.

                                        {
        return pollingInterval.multipliedBy(numberOfDataPoints);
    }

Integer kernel.models.variables.VoltageProvider.getNumberOfDataPoints

(

)

Returns

The number of data points in this provider

Definition at line 97 of file models/variables/VoltageProvider.java.

                                          {
        return numberOfDataPoints;
    }

Duration kernel.models.variables.VoltageProvider.getPollingInterval

(

)

Returns

The duration between polling cycles

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

                                        {
        return this.pollingInterval;
    }

List<Voltage> kernel.models.variables.VoltageProvider.getValues

(

)

Returns

The measured voltages

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

                                    {
        return voltages;
    }

Boolean kernel.models.variables.VoltageProvider.isProvidingVariables

(

)

Returns

Boolean#FALSE if not providing variables, else Boolean#TRUE

Definition at line 81 of file models/variables/VoltageProvider.java.

                                         {
        return isThreadAlive;
    }

void kernel.models.variables.VoltageProvider.removeOnChangeListener

(

VariableChangeEventListener< Voltage >

listener

)

Parameters

listener

The listener to remove

Definition at line 143 of file models/variables/VoltageProvider.java.

     {
        listeners.remove(listener);
    }

void kernel.models.variables.VoltageProvider.setNumberOfDataPoints

(

Integer

numberOfDataPoints

)

Parameters

numberOfDataPoints

The desired number of data points

Definition at line 105 of file models/variables/VoltageProvider.java.

                                                                 {
        this.numberOfDataPoints = numberOfDataPoints;
    }

void kernel.models.variables.VoltageProvider.setPollingInterval

(

Duration

interval

)

throws NegativeDurationException

Parameters

interval

The desired polling interval

Exceptions

NegativeDurationException

If the desired interval is negative

Definition at line 115 of file models/variables/VoltageProvider.java.

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

---

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

• models/variables/VoltageProvider.java