me.legrange.panstamp

Interface Endpoint<T>

Type Parameters:

T - type of value supported by the endpoint

public interface Endpoint<T>

A PanStamp endpoint

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Endpoint.Type Type of value sent and/or received by an endpoint.

Method Summary

Modifier and Type	Method and Description
void	addListener(EndpointListener<T> el) Add a listener to the endpoint.
String	getName() Return the name of this endpoint.
Register	getRegister() Get the register to which this endpoint is associated.
Endpoint.Type	getType() Return the type of the data supported by this endpoint
String	getUnit() Return the unit currently used for converting the endpoint values.
List<String>	getUnits() Get the units supported by this endpoint
T	getValue() returns the current value of the endpoint.
T	getValue(String unit) returns the current value of the endpoint in the given unit.
boolean	hasValue() Checks if the endpoint has a value available.
boolean	isOutput() Test if the endpoint is an output or just an input.
void	removeListener(EndpointListener<T> el) Remove a listener from the endpoint.
void	setUnit(String unit) Set the unit to use for converting endpoint values.
void	setValue(String unit, T value) set the value of the endpoint
void	setValue(T value) set the value of the endpoint

Method Detail

getName

String getName()

Return the name of this endpoint.

Returns:

The endpoint name

getType

Endpoint.Type getType()

Return the type of the data supported by this endpoint

Returns:

Type of endpoint

getUnits

List<String> getUnits()

Get the units supported by this endpoint

Returns:

The supported units. This can be empty

getUnit

String getUnit()

Return the unit currently used for converting the endpoint values. This is the unit set by calling getUnit() or the default unit to use if no unit is set. The default unit is the first unit in the device definition, if units are defined, or an empty string.

Returns:

The unit used.

setUnit

void setUnit(String unit)
      throws me.legrange.panstamp.NoSuchUnitException

Set the unit to use for converting endpoint values.

Parameters:

unit - The unit to use

Throws:

NoSuchUnitException - Thrown if the unit specified does not exist.

See Also:

for more information.

addListener

void addListener(EndpointListener<T> el)

Add a listener to the endpoint.

Parameters:

el - Listener that will receive incoming data

removeListener

void removeListener(EndpointListener<T> el)

Remove a listener from the endpoint.

Parameters:

el - The listener to remove

hasValue

boolean hasValue()

Checks if the endpoint has a value available.

Returns:

True if the endpoint has a value

getValue

T getValue(String unit)
    throws NetworkException

returns the current value of the endpoint in the given unit.

Parameters:

unit - Unit in which to receive the value

Returns:

The value

Throws:

NetworkException - Thrown if there is a problem retrieving and endpoint value.

getValue

T getValue()
    throws NetworkException

returns the current value of the endpoint.

Returns:

The value

Throws:

NetworkException - Thrown if there is a problem retrieving and endpoint value.

setValue

void setValue(String unit,
              T value)
       throws NetworkException

set the value of the endpoint

Parameters:

unit - The unit in which the value is passed.

value - The value to set

Throws:

NetworkException - Thrown if there is a problem setting the endpoint value.

setValue

void setValue(T value)
       throws NetworkException

set the value of the endpoint

Parameters:

value - The value to set

Throws:

NetworkException - Thrown if there is a problem setting the endpoint value.

isOutput

boolean isOutput()

Test if the endpoint is an output or just an input.

Returns:

True if the endpoint is an output.

Since:

1.2

getRegister

Register getRegister()

Get the register to which this endpoint is associated.

Returns:

The register containing this endpoint.