com.invertor.modbus.net.ModbusConnectionSerial Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jlibmodbus Show documentation

Implementation of the Modbus protocol in Java language

There is a newer version: 1.2.9.0

package com.invertor.modbus.net;

import com.invertor.modbus.exception.ModbusIOException;
import com.invertor.modbus.net.stream.base.ModbusInputStream;
import com.invertor.modbus.net.stream.base.ModbusOutputStream;
import com.invertor.modbus.net.transport.ModbusTransport;
import com.invertor.modbus.serial.SerialPort;
import com.invertor.modbus.serial.SerialPortException;

/*
 * Copyright (C) 2016 "Invertor" Factory", JSC
 * [http://www.sbp-invertor.ru]
 *
 * This file is part of JLibModbus.
 *
 * 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.
 *
 * Authors: Vladislav Y. Kochedykov, software engineer.
 * email: [email protected]
 */

/**
 * this class is an extension of the ModbusConnection class
 * to implement features for all serial port based connections.
 *
 * @see ModbusConnectionRTU
 * @see ModbusConnectionASCII
 * @see ModbusConnection
 */
abstract class ModbusConnectionSerial extends ModbusConnection {

    /**
     * instance of com.invertor.modbus.serial.SerialPort class,
     * which is a wrapper for concrete serial API implementation.
     *
     * @see SerialPort
     */
    final private SerialPort serial;
    final private ModbusTransport transport;

    ModbusConnectionSerial(SerialPort serial, ModbusTransport transport) {
        this.serial = serial;
        this.transport = transport;
    }

    @Override
    public void open() throws ModbusIOException {
        if (!isOpened()) {
            try {
                this.serial.open();
                setOpened(true);
            } catch (SerialPortException e) {
                throw new ModbusIOException(e);
            }
        }
    }

    @Override
    public void close() {
        setOpened(false);
        this.serial.close();
    }

    @Override
    public ModbusOutputStream getOutputStream() {
        return transport.getOutputStream();
    }

    @Override
    public ModbusInputStream getInputStream() {
        return transport.getInputStream();
    }

    @Override
    public ModbusTransport getTransport() {
        return transport;
    }
}