me.legrange.panstamp

Class Register

java.lang.Object

me.legrange.panstamp.Register

public final class Register
extends Object

An abstraction of a panStamp register.

Since:

1.0

Author:

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

Method Summary

Modifier and Type	Method and Description
void	addListener(RegisterListener l) Add a listener to receive register updates
PanStamp	getDevice() Get the device to which this register belongs.
Endpoint	getEndpoint(String name) return the endpoint for the given name
List<Endpoint>	getEndpoints() return the endpoints defined for this register
int	getId() return the register ID
String	getName() Get the register name as defined in XML.
List<Parameter>	getParameters() Returns the parameters (if any) for this endpoint
byte[]	getValue() get the value of the register
boolean	hasEndpoint(String name) returns true if the device has an endpoint with the given name
boolean	hasValue() return true if the register has a currently known value
boolean	isStandard() return true if the register is one of the panStamp standard registers.
void	removeListener(RegisterListener l) remove a listener
void	setValue(byte[] value) set the register value and send to remote node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getId

public int getId()

return the register ID

Returns:

The id of this register.

getName

public String getName()

Get the register name as defined in XML.

Returns:

The name of the register.

getDevice

public PanStamp getDevice()

Get the device to which this register belongs.

Returns:

The panStamp device.

getEndpoints

public List<Endpoint> getEndpoints()

return the endpoints defined for this register

Returns:

The endpoints

addListener

public void addListener(RegisterListener l)

Add a listener to receive register updates

Parameters:

l - listener to add

removeListener

public void removeListener(RegisterListener l)

remove a listener

Parameters:

l - listener to remove

setValue

public void setValue(byte[] value)
              throws NetworkException

set the register value and send to remote node

Parameters:

value - the new value

Throws:

NetworkException - Thrown if there is a problem updating the register

getValue

public byte[] getValue()
                throws me.legrange.panstamp.NoValueException

get the value of the register

Returns:

The value of the register

Throws:

me.legrange.panstamp.NoValueException - Thrown if the register value is requested but no value is available.

hasValue

public boolean hasValue()

return true if the register has a currently known value

Returns:

True if the register's value is known.

getEndpoint

public Endpoint getEndpoint(String name)
                     throws EndpointNotFoundException

return the endpoint for the given name

Parameters:

name - The name of the endpoint needed

Returns:

The endpoint object

Throws:

EndpointNotFoundException - Thrown if an endpoint with that name could not be found.

hasEndpoint

public boolean hasEndpoint(String name)
                    throws NetworkException

returns true if the device has an endpoint with the given name

Parameters:

name - Name of endpoint we're querying

Returns:

True if the endpoint is known.

Throws:

NetworkException - Thrown if an error is experienced

getParameters

public List<Parameter> getParameters()

Returns the parameters (if any) for this endpoint

Returns:

The list of parameters

isStandard

public boolean isStandard()

return true if the register is one of the panStamp standard registers.

Returns:

True if it is standard