com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of j2mod Show documentation
A Modbus TCP/UDP/Serial Master and Slave implementation
There is a newer version: 3.2.1
/*
 * Copyright 2002-2016 jamod & j2mod development teams
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ghgande.j2mod.modbus.msg;

import com.ghgande.j2mod.modbus.Modbus;
import com.ghgande.j2mod.modbus.procimg.InputRegister;
import com.ghgande.j2mod.modbus.procimg.SimpleInputRegister;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Arrays;

/**
 * Class implementing a ReadInputRegistersRequest. The implementation
 * directly correlates with the class 0 function read multiple registers (FC
 * 4). It encapsulates the corresponding response message.
 *
 * @author Dieter Wimberger
 * @author Steve O'Hara (4NG)
 * @version 2.0 (March 2016)
 */
public class ReadInputRegistersResponse extends ModbusResponse {

    // instance attributes
    private int byteCount;
    private InputRegister[] registers;

    /**
     * Constructs a new ReadInputRegistersResponse instance.
     */
    public ReadInputRegistersResponse() {
        super();

        setFunctionCode(Modbus.READ_INPUT_REGISTERS);
    }

    /**
     * Constructs a new ReadInputRegistersResponse instance.
     *
     * @param registers the InputRegister[] holding response input registers.
     */
    public ReadInputRegistersResponse(InputRegister[] registers) {
        super();

        setFunctionCode(Modbus.READ_INPUT_REGISTERS);
        setDataLength(registers == null ? 0 : (registers.length * 2 + 1));

        this.registers = registers == null ? null : Arrays.copyOf(registers, registers.length);
        byteCount = registers == null ? 0 : (registers.length * 2);
    }

    /**
     * Returns the number of bytes that have been read.
     *
     * @return the number of bytes that have been read as int.
     */
    public int getByteCount() {
        return byteCount;
    }

    /**
     * Returns the number of words that have been read. The returned value
     * should be half as much as the byte count of the response.
     *
     * @return the number of words that have been read as int.
     */
    public int getWordCount() {
        return byteCount / 2;
    }

    /**
     * Set the number of words to be written.
     * @param count Number of words in response
     */
    public void setWordCount(int count) {
        byteCount = count * 2;
    }

    /**
     * Returns the InputRegister at the given position (relative to the
     * reference used in the request).
     *
     * @param index the relative index of the InputRegister.
     *
     * @return the register as InputRegister.
     *
     * @throws IndexOutOfBoundsException if the index is out of bounds.
     */
    public InputRegister getRegister(int index) throws IndexOutOfBoundsException {
        if (index < 0) {
            throw new IndexOutOfBoundsException(index + " < 0");
        }

        if (index >= getWordCount()) {
            throw new IndexOutOfBoundsException(index + " >= " + getWordCount());
        }

        return registers[index];
    }

    /**
     * Returns the value of the register at the given position (relative to the
     * reference used in the request) interpreted as usigned short.
     *
     * @param index the relative index of the register for which the value should
     *              be retrieved.
     *
     * @return the unsigned short value as an int.
     *
     * @throws IndexOutOfBoundsException if the index is out of bounds.
     */
    public int getRegisterValue(int index) throws IndexOutOfBoundsException {
        return getRegister(index).toUnsignedShort();
    }

    /**
     * Returns a reference to the array of input registers read.
     *
     * @return a InputRegister[] instance.
     */
    public synchronized InputRegister[] getRegisters() {
        InputRegister[] dest = new InputRegister[registers.length];
        System.arraycopy(registers, 0, dest, 0, dest.length);
        return dest;
    }

    /**
     * Sets the entire block of registers for this response
     * @param registers Array of registers
     */
    public synchronized void setRegisters(InputRegister[] registers) {
        setDataLength(registers == null ? 0 : (registers.length * 2 + 1));
        this.registers = registers == null ? null : Arrays.copyOf(registers, registers.length);
        byteCount = registers == null ? 0 : (registers.length * 2);
    }

    @Override
    public void writeData(DataOutput dout) throws IOException {
        dout.writeByte(byteCount);

        for (int k = 0; k < getWordCount(); k++) {
            dout.write(registers[k].toBytes());
        }
    }

    @Override
    public void readData(DataInput din) throws IOException {
        byteCount = din.readUnsignedByte();

        InputRegister[] inputRegisters = new InputRegister[getWordCount()];
        for (int k = 0; k < getWordCount(); k++) {
            inputRegisters[k] = new SimpleInputRegister(din.readByte(), din.readByte());
        }
        registers = inputRegisters;

        setDataLength(byteCount);
    }

    @Override
    public byte[] getMessage() {
        byte[] result = new byte[registers.length * 2 + 1];
        result[0] = (byte)(registers.length * 2);

        for (int i = 0; i < registers.length; i++) {
            byte[] value = registers[i].toBytes();

            result[1 + i * 2] = value[0];
            result[2 + i * 2] = value[1];
        }
        return result;
    }
}