me.legrange.swap

Class UserMessage

java.lang.Object

me.legrange.swap.UserMessage

All Implemented Interfaces:

SwapMessage

public class UserMessage
extends Object
implements SwapMessage

An implementation of SwapMessage for messages originating from the application.

Since:

1.0

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface me.legrange.swap.SwapMessage

SwapMessage.Type

Field Summary

Fields inherited from interface me.legrange.swap.SwapMessage

MAX_STANDARD_REGISTER

Constructor Summary

Constructors

Constructor and Description
UserMessage(boolean extended, SwapMessage.Type type, int sender, int receiver, int registerID, byte[] registerValue)

Method Summary

Modifier and Type	Method and Description
int	getFunction() Get the SWAP function code for this message.
int	getHops()
int	getLqi()
int	getReceiver()
int	getRegisterAddress()
int	getRegisterID()
byte[]	getRegisterValue()
int	getRssi()
int	getSecurity()
int	getSecurityNonce()
int	getSender()
String	getText()
SwapMessage.Type	getType()
boolean	isExtended()
boolean	isStandardRegister()
void	setRegisterAddress(int registerAddress)
void	setSecurity(int security)
void	setSecurityNonce(int securityNonce)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserMessage

public UserMessage(boolean extended,
                   SwapMessage.Type type,
                   int sender,
                   int receiver,
                   int registerID,
                   byte[] registerValue)

Method Detail

getFunction

public int getFunction()

Description copied from interface: SwapMessage

Get the SWAP function code for this message. Query = 1, Command = 2 and Status = 0.

Specified by:

getFunction in interface SwapMessage

Returns:

The function code.

isStandardRegister

public boolean isStandardRegister()

Specified by:

isStandardRegister in interface SwapMessage

getType

public SwapMessage.Type getType()

Specified by:

getType in interface SwapMessage

isExtended

public boolean isExtended()

Specified by:

isExtended in interface SwapMessage

getRssi

public int getRssi()

Specified by:

getRssi in interface SwapMessage

getLqi

public int getLqi()

Specified by:

getLqi in interface SwapMessage

getSender

public int getSender()

Specified by:

getSender in interface SwapMessage

getReceiver

public int getReceiver()

Specified by:

getReceiver in interface SwapMessage

getHops

public int getHops()

Specified by:

getHops in interface SwapMessage

getSecurity

public int getSecurity()

Specified by:

getSecurity in interface SwapMessage

getSecurityNonce

public int getSecurityNonce()

Specified by:

getSecurityNonce in interface SwapMessage

getRegisterAddress

public int getRegisterAddress()

Specified by:

getRegisterAddress in interface SwapMessage

getRegisterID

public int getRegisterID()

Specified by:

getRegisterID in interface SwapMessage

getRegisterValue

public byte[] getRegisterValue()

Specified by:

getRegisterValue in interface SwapMessage

getText

public String getText()

Specified by:

getText in interface SwapMessage

toString

public String toString()

Overrides:

toString in class Object

setSecurity

public void setSecurity(int security)

setSecurityNonce

public void setSecurityNonce(int securityNonce)

setRegisterAddress

public void setRegisterAddress(int registerAddress)