com.ghgande.j2mod.modbus.io

Interface NonWordDataHandler

Deprecated.

In the interests of keeping the library simple, this will be removed in a future release

@Deprecated
public interface NonWordDataHandler

Interface implementing a non word data handler for the read/write multiple register commands. This interface can be used by any class which works with multiple words of data for a non-standard data item. For example, message may involve data items which are floating point values or string.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Method Summary

Modifier and Type	Method and Description
int	commitUpdate() Deprecated. Commits the data if it has been read into an intermediate repository.
byte[]	getData() Deprecated. Returns the intermediate raw non-word data.
int	getWordCount() Deprecated. Returns the word count of the data.
void	prepareData(int reference, int count) Deprecated. Prepares the raw data, putting it together from a backing data store.
void	readData(DataInput in, int reference, int count) Deprecated. Reads the non-word raw data based on an arbitrary implemented structure.

Method Detail

getData

byte[] getData()

Deprecated.

Returns the intermediate raw non-word data.

An implementation would need to provide a means of converting between the raw byte data and the registers that are present in actual messages.

Returns:

the raw data as byte[].

readData

void readData(DataInput in,
              int reference,
              int count)
       throws IOException

Deprecated.

Reads the non-word raw data based on an arbitrary implemented structure.

Parameters:

in - the DataInput to read from.

reference - to specify the offset as int.

count - to specify the amount of bytes as int.

Throws:

IOException - if I/O fails.

EOFException - if the stream ends before all data is read.

getWordCount

int getWordCount()

Deprecated.

Returns the word count of the data. Note that this should be the length of the byte array divided by two.

Returns:

the number of words the data consists of.

commitUpdate

int commitUpdate()

Deprecated.

Commits the data if it has been read into an intermediate repository.

This method is called for a message (for example, a WriteMultipleRegistersRequest instance) when finished with reading, for creating a response.

Returns:

-1 if the commit was successful, a Modbus exception code valid for the read/write multiple registers commands otherwise.

prepareData

void prepareData(int reference,
                 int count)

Deprecated.

Prepares the raw data, putting it together from a backing data store.

This method is called for a message (for example, * ReadMultipleRegistersRequest) when finished with reading, for creating a response.

Parameters:

reference - to specify the offset as int.

count - to specify the number of bytes as int.