org.avineas.fins

Class Address

java.lang.Object

org.avineas.fins.Address

public final class Address
extends java.lang.Object

FINS addressing. Convenience methods for handling FINS addresses. FINS addresses consist of 3 numbers: a network address containing a group of nodes that can communicate with each other. Every node can have one or more units which can be seen as specific destinations on a node. The string representation of FINS addresses is a/b/c where a is the network number, b is the node number and c is the unit number, like 12/2/1.

Since:

3-nov-2005

Author:

A. van Wijngaarden

Constructor Summary

Constructors

Constructor and Description
Address() Default constructor.
Address(byte[] from, int offset) Construct an address from a byte array, normally part of a frame.
Address(int na, int nn, int unit) Construct an address with specific network, node and unit numbers.
Address(java.lang.String addr) Construct an address from a string.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
byte	getNetworkAddress() Get the network address.
java.lang.String	getNodeAsString() Get the node part of this address as string value.
byte	getNodeNumber() Get the node number.
byte	getUnitAddress() Get the unit address value of this address.
int	hashCode()
void	set(byte[] to, int offset) Encode this address into a message, normally a FINS packet or frame.
void	setNetworkAddress(byte networkAddress) Set the network address, this is the first byte of the FINS addressing.
void	setNodeNumber(byte nodeNumber) Set the node number of this address.
void	setUnitAddress(byte unitAddress) Set the unit address.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address()

Default constructor. Constructs an address with network 0, node 1 and unit 0.

Address

public Address(byte[] from,
       int offset)

Construct an address from a byte array, normally part of a frame.

Parameters:

from - The byte array to extract the address from

offset - The offset in the byte array to start the decoding

Address

public Address(int na,
       int nn,
       int unit)

Construct an address with specific network, node and unit numbers.

Parameters:

na - The network address

nn - The node address

unit - The unit on the node

Address

public Address(java.lang.String addr)

Construct an address from a string. This string must have the form network/node/unit where the unit value is optional (in case all units from a node should be referred or the address is actually a node address).

Parameters:

addr - The string representation of the address

Method Detail

getNetworkAddress

public byte getNetworkAddress()

Get the network address.

Returns:

The byte representing the network address

setNetworkAddress

public void setNetworkAddress(byte networkAddress)

Set the network address, this is the first byte of the FINS addressing.

Parameters:

networkAddress - The network address of this address object

getNodeNumber

public byte getNodeNumber()

Get the node number.

Returns:

The byte representing the node number

setNodeNumber

public void setNodeNumber(byte nodeNumber)

Set the node number of this address. The node number is the second/middle byte in FINS addressing.

Parameters:

nodeNumber - The node number

getUnitAddress

public byte getUnitAddress()

Get the unit address value of this address. The unit address is the last byte in the FINS addressing.

Returns:

The unit address byte value

setUnitAddress

public void setUnitAddress(byte unitAddress)

Set the unit address.

Parameters:

unitAddress - The unit address to set

set

public void set(byte[] to,
       int offset)

Encode this address into a message, normally a FINS packet or frame.

Parameters:

to - The byte array to encode the address in

offset - The offset to start in the byte array

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getNodeAsString

public java.lang.String getNodeAsString()

Get the node part of this address as string value. This is the network address and node number separated by a slash, like 1/4.

Returns:

The string representation of the node part