net.wimpi.modbus.msg.ModbusMessage Maven / Gradle / Ivy
Show all versions of jamod Show documentation
/***
* 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 net.wimpi.modbus.msg;
import net.wimpi.modbus.io.Transportable;
/**
* Interface defining a Modbus Message.
*
* @author Dieter Wimberger
* @version 1.2 (@date@)
*/
public interface ModbusMessage
extends Transportable {
/**
* Sets the flag that marks this ModbusMessage as headless
* (for serial transport).
*/
public void setHeadless();
/**
* Returns the transaction identifier of this
* ModbusMessage as int.
* The identifier is a 2-byte (short) non negative
* integer value valid in the range of 0-65535.
*
* @return the transaction identifier as int.
*/
public int getTransactionID();
/**
* Returns the protocol identifier of this
* ModbusMessage as int.
* The identifier is a 2-byte (short) non negative
* integer value valid in the range of 0-65535.
*
* @return the protocol identifier as int.
*/
public int getProtocolID();
/**
* Returns the length of the data appended
* after the protocol header.
*
* @return the data length as int.
*/
public int getDataLength();
/**
* Returns the unit identifier of this
* ModbusMessage as int.
* The identifier is a 1-byte non negative
* integer value valid in the range of 0-255.
*
* @return the unit identifier as int.
*/
public int getUnitID();
/**
* Returns the function code of this
* ModbusMessage as int.
* The function code is a 1-byte non negative
* integer value valid in the range of 0-127.
* Function codes are ordered in conformance
* classes their values are specified in
* net.wimpi.modbus.Modbus.
*
* @return the function code as int.
*
* @see net.wimpi.modbus.Modbus
*/
public int getFunctionCode();
/**
* Returns the raw message as String
* containing a hexadecimal series of bytes.
*
* This method is specially for debugging purposes,
* allowing to log the communication in a manner used
* in the specification document.
*
* @return the raw message as String
* containing a hexadecimal series of bytes.
*
*/
public String getHexMessage();
}//interface ModbusMessage