ro.ciprianpascu.sbus.msg.ModbusRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of j2sbus Show documentation
jamod is an object oriented implementation of the S-Bus protocol, realized 100% in Java. It allows to quickly realize master and slave applications in various transport flavors (IP and serial).
The newest version!
/**
 * Copyright 2002-2010 jamod development team
 *
 * 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 ro.ciprianpascu.sbus.msg;

import ro.ciprianpascu.sbus.Modbus;
import ro.ciprianpascu.sbus.procimg.ProcessImageImplementation;

/**
 * Abstract class implementing a {@link ModbusRequest}.
 * This class provides specialised implementations with
 * the functionality they have in common.
 *
 * @author Dieter Wimberger
 * @author Ciprian Pascu

 * @version %I% (%G%)
 */
public abstract class ModbusRequest extends ModbusMessageImpl {

    /**
     * Returns the {@link ModbusResponse} that
     * correlates with this {@link ModbusRequest}.
* 
     *
     * @return the corresponding {@link ModbusResponse}.
     *
     *         public abstract ModbusResponse getResponse();
     */

    /**
     * Returns the {@link ModbusResponse} that
     * represents the answer to this {@link ModbusRequest}.
* 
     * The implementation should take care about assembling
     * the reply to this {@link ModbusRequest}.
* 
     *
     * @return the corresponding {@link ModbusResponse}.
     */
    public abstract ModbusResponse createResponse(ProcessImageImplementation procImg);

    /**
     * Factory method for creating exception responses with the
     * given exception code.
     *
     * @param EXCEPTION_CODE the code of the exception.
     * @return a ModbusResponse instance representing the exception
     *         response.
     */
    public ModbusResponse createExceptionResponse(int EXCEPTION_CODE) {
        ExceptionResponse response = new ExceptionResponse(this.getFunctionCode(), EXCEPTION_CODE);
        response.setSourceSubnetID(this.getSourceSubnetID());
        response.setSourceUnitID(this.getSourceUnitID());
		response.setSourceDeviceType(this.getSourceDeviceType());
        response.setSubnetID(this.getSubnetID());
        response.setUnitID(this.getUnitID());
        return response;
    }// createExceptionResponse

    /**
     * Factory method creating the required specialized {@link ModbusRequest}
     * instance.
     *
     * @param functionCode the function code of the request as {@link int}.
     * @return a ModbusRequest instance specific for the given function type.
     */
    public static ModbusRequest createModbusRequest(int functionCode) {
        ModbusRequest request = null;

        switch (functionCode) {
            case Modbus.READ_MULTIPLE_REGISTERS:
                request = new ReadMultipleRegistersRequest();
                break;
            case Modbus.READ_STATUS_CHANNELS_REQUEST:
                request = new ReadStatusChannelsRequest();
                break;
            case Modbus.READ_TEMPERATURE_REQUEST:
                request = new ReadTemperatureRequest();
                break;
            case Modbus.WRITE_MULTIPLE_REGISTERS:
                request = new WriteMultipleRegistersRequest();
                break;
            case Modbus.WRITE_SINGLE_CHANNEL_REQUEST:
                request = new WriteSingleChannelRequest();
                break;
            default:
                request = new IllegalFunctionRequest(functionCode);
                break;
        }
        return request;
    }// createModbusRequest
    
}// class ModbusRequest